Skip to content

Commit

Permalink
README update
Browse files Browse the repository at this point in the history
  • Loading branch information
deprov447 committed Mar 27, 2024
1 parent 8a9ca15 commit 55469f2
Showing 1 changed file with 37 additions and 40 deletions.
77 changes: 37 additions & 40 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,44 @@
<img src="https://raw.githubusercontent.com/deprov447/first-page/1d72955f03ddece33ecbe751723200fcd223ec1b/assets/logos/logo-text%201/vector/default-monochrome.svg" width="500" />

> IMPORTANT: This app heavily requires an actual root domain (not the ones provided by netlify or vercel or GCP). This is due to requirement of subdomain (for ex: deprov447.getfront.space). Now I don't have both time, and money to maintain a actual domain, so just for local usage, we are going to use `localhost` as root domain.
Front space is a platform to quickly create single paged websites and host it for the world to see.

## Local servers

> Import demo data in your mongo to start using the app. Run `mongorestore ./db_demo`
## Docker Compose

- source .env file in root dir (On linux: `source .env`)
- `docker compose up`
- Open localhost:81 in browser

## Non docker way

### Client

- Populate `./client/.env` with following keys:
- `REACT_APP_SERVER_URL`
- `REACT_APP_CLIENT_URL`
- `REACT_APP_IMGBB_API_KEY`
- `npm i`
- `npm start`

### Server

- Populate `./server/.env` with following keys:
- `DB_ADDR`
- `CLIENT_URL`
- `JWT_SECRET`
- `REFRESH_TOKEN_SECRET`
- `COOKIE_SECRET`
- `SESSION_EXPIRY`
- `REFRESH_TOKEN_EXPIRY`
- `npm i`
- `npm start`


## Build with

Of course love. But also a number of amazing technologies.
Expand Down Expand Up @@ -32,43 +69,3 @@ Of course love. But also a number of amazing technologies.
- Github actions
- Cloudflare
- Hostinger

## Some Pages Made

![img3](https://api.microlink.io?url=https%3A%2F%2Fhimniz.getfront.space&overlay.browser=dark&overlay.background=%2300000000&screenshot=true&meta=false&embed=screenshot.url)

![img2](https://api.microlink.io?url=https%3A%2F%2Fdeprov447.getfront.space&overlay.browser=dark&overlay.background=%2300000000&screenshot=true&meta=false&embed=screenshot.url)

![img1](https://api.microlink.io?url=https%3A%2F%2Fprinsu-pyaara.getfront.space&overlay.browser=dark&overlay.background=%2300000000&screenshot=true&meta=false&embed=screenshot.url)

## Links

**Blog:** [https://blogs.deprov447.me/front-space](https://blogs.deprov447.me/front-space)

**Website:** [https://getfront.space](https://getfront.space)

**Source code:** [https://github.com/deprov447/frontspace/](https://github.com/deprov447/frontspace/issues/new/choose)

## Local servers

### Client

- Populate `./client/.env` with following keys:
- `REACT_APP_SERVER_URL`
- `REACT_APP_CLIENT_URL`
- `REACT_APP_IMGBB_API_KEY`
- `npm i`
- `npm start`

### Server

- Populate `./server/.env` with following keys:
- `DB_ADDR`
- `CLIENT_URL`
- `JWT_SECRET`
- `REFRESH_TOKEN_SECRET`
- `COOKIE_SECRET`
- `SESSION_EXPIRY`
- `REFRESH_TOKEN_EXPIRY`
- `npm i`
- `npm start`

0 comments on commit 55469f2

Please sign in to comment.