Skip to content

Commit f0e4c61

Browse files
authored
Update README.md
1 parent 88e7e68 commit f0e4c61

File tree

1 file changed

+29
-29
lines changed

1 file changed

+29
-29
lines changed

README.md

Lines changed: 29 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -133,17 +133,17 @@ A typical product (SaaS, etc.) usually consists of following services:
133133
- Configuration
134134
- Create local environment file `cp .env.dev.example .env`
135135
- Modify `.env` for
136-
- PORT `8000`
137-
- NODE_ENV `development` | `production`
138-
- SECURITY_SECRET (Use [passwordsgenerator](https://passwordsgenerator.net))
139-
- SECURITY_SALT_ROUNDS `10`
140-
- MONGO_URL `mongodb://localhost:27017/example`
141-
- LANDING_URL `http://localhost:3000`
142-
- WEB_URL `http://localhost:5000`
143-
- API_URL `http://localhost:8000`
144-
- EMAIL_ON `0` | `1` (in development, you can toggle to send emails or not)
145-
- EMAIL_TEST (send test emails to this address)
146-
- EMAIL_HOST, EMAIL_USER, EMAIL_PASSWORD (use any email servive, eg. [mailgun.com](https://www.mailgun.com/) and get info to start sending emails
136+
- `PORT` (`8000`)
137+
- `NODE_ENV` (`development` | `production`)
138+
- `SECURITY_SECRET` (Use [passwordsgenerator](https://passwordsgenerator.net))
139+
- `SECURITY_SALT_ROUNDS` (`10`)
140+
- `MONGO_URL` (`mongodb://localhost:27017/example`)
141+
- `LANDING_URL` (`http://localhost:3000`)
142+
- `WEB_URL` (`http://localhost:5000`)
143+
- `API_URL` (`http://localhost:8000`)
144+
- `EMAIL_ON` (`0` | `1` (in development, you can toggle to send emails or not))
145+
- `EMAIL_TEST` (send test emails to this address)
146+
- `EMAIL_HOST`, `EMAIL_USER`, `EMAIL_PASSWORD` (use any email servive, eg. [mailgun.com](https://www.mailgun.com/) and get info to start sending emails
147147
- Setup
148148
- Install packages and seed database `npm run setup`
149149
- Run
@@ -154,13 +154,13 @@ A typical product (SaaS, etc.) usually consists of following services:
154154
- Configuration
155155
- Create local environment file `cp .env.dev.example .env`
156156
- Modify `.env` for
157-
- PORT `3000`
158-
- NODE_ENV `development` | `production`
159-
- LANDING_URL `http://localhost:3000`
160-
- WEB_URL `http://localhost:5000`
161-
- API_URL `http://localhost:8000`
162-
- CONTACT_PHONE, CONTACT_EMAIL, CONTACT_ADDRESS
163-
- GA_TRACKING_ID (Google analytics tracking ID)
157+
- `PORT` (`3000`)
158+
- `NODE_ENV` (`development` | `production`)
159+
- `LANDING_URL1 (`http://localhost:3000`)
160+
- `WEB_URL` (`http://localhost:5000`)
161+
- `API_URL` (`http://localhost:8000`)
162+
- `CONTACT_PHONE`, `CONTACT_EMAIL`, `CONTACT_ADDRESS` (your contact information)
163+
- `GA_TRACKING_ID` (Google analytics tracking ID)
164164
- Setup
165165
- Install dependencies: `npm install`
166166
- Run
@@ -171,10 +171,10 @@ A typical product (SaaS, etc.) usually consists of following services:
171171
- Configuration
172172
- Create local environment file `cp .env.dev.example .env`
173173
- Modify `.env` for
174-
- PORT `5000`
175-
- REACT_APP_LANDING_URL `http://localhost:3000`
176-
- REACT_APP_WEB_URL `http://localhost:5000`
177-
- REACT_APP_API_URL `http://localhost:8000`
174+
- `PORT` (`5000`)
175+
- `REACT_APP_LANDING_URL` (`http://localhost:3000`)
176+
- `REACT_APP_WEB_URL` (`http://localhost:5000`)
177+
- `REACT_APP_API_URL` (`http://localhost:8000`)
178178
- Setup
179179
- Install dependencies: `npm install`
180180
- Run
@@ -194,13 +194,13 @@ A typical product (SaaS, etc.) usually consists of following services:
194194
- Configuration
195195
- Create local environment file `cp .env.dev.example .env`
196196
- Modify `.env` for
197-
- APP_ID `com.example` (your app bundle ID)
198-
- APP_VERSION `0.0.1` (increment this for each publish on App or Play Store)
199-
- APP_BUILD `1` (increment this for each publish on App or Play Store)
200-
- APP_ENV `development` | `production`
201-
- LANDING_URL `http://<your local network IP>:3000`
202-
- WEB_URL `http://<your local network IP>:5000`
203-
- API_URL `http://<your local network IP>:8000`
197+
- `APP_ID` (`com.example` (your app bundle ID))
198+
- `APP_VERSION` (`0.0.1` (increment this for each publish on App or Play Store))
199+
- `APP_BUILD` (`1` (increment this for each publish on App or Play Store))
200+
- `APP_ENV` (`development` | `production`)
201+
- `LANDING_URL` (`http://<your local network IP>:3000`)
202+
- `WEB_URL` (`http://<your local network IP>:5000`)
203+
- `API_URL` (`http://<your local network IP>:8000`)
204204
- Tip: use `ifconfig` on macOS or Linux to get your local IP address
205205
- Setup
206206
- Install dependencies: `npm install`

0 commit comments

Comments
 (0)