Skip to content

Commit 311e524

Browse files
committed
Update readme
1 parent f26626d commit 311e524

File tree

1 file changed

+23
-1
lines changed

1 file changed

+23
-1
lines changed

backend/user-service/README.md

Lines changed: 23 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,29 @@
88

99
2. To connect to your cloud MongoDB instead of your local MongoDB, set the `NODE_ENV` to `production` instead of `development`.
1010

11-
3. Update `MONGO_CLOUD_URI`, `MONGO_LOCAL_URI`, `FIREBASE_PROJECT_ID`, `FIREBASE_PRIVATE_KEY`, `FIREBASE_CLIENT_EMAIL`, `FIREBASE_STORAGE_BUCKET`, `JWT_SECRET`.
11+
3. Update the following variables in the `.env` file:
12+
13+
- `MONGO_CLOUD_URI`
14+
15+
- `MONGO_LOCAL_URI`
16+
17+
- `FIREBASE_PROJECT_ID`
18+
19+
- `FIREBASE_PRIVATE_KEY`
20+
21+
- `FIREBASE_CLIENT_EMAIL`
22+
23+
- `FIREBASE_STORAGE_BUCKET`
24+
25+
- `JWT_SECRET`
26+
27+
- `SERVICE`: Email service to use to send account verification links, e.g. `gmail`.
28+
29+
- `USER`: Email address that you will be using, e.g. `[email protected]`.
30+
31+
- `PASS`: The app password. For gmail accounts, please refer to this [link](https://support.google.com/accounts/answer/185833?hl=en).
32+
33+
- `REDIS_URI`
1234

1335
4. A default admin account (`email: [email protected]` and `password: Admin@123`) wil be created. If you wish to change the default credentials, update them in `.env`. Alternatively, you can also edit your credentials and user profile after you have created the default account.
1436

0 commit comments

Comments
 (0)