Skip to content

Commit 68941fb

Browse files
committed
Update readme
1 parent 273e2ff commit 68941fb

File tree

3 files changed

+13
-9
lines changed

3 files changed

+13
-9
lines changed

README.md

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

99
We will be using Docker to set up PeerPrep. Install Docker [here](https://docs.docker.com/get-started/get-docker).
1010

11-
Follow the instructions in the [backend directory](./backend/README.md) first before proceeding.
11+
Follow the instructions in the [backend directory](./backend/) first before proceeding.
1212

1313
Run:
1414
```

backend/question-service/README.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Question Service
22

3-
> If you have not set-up either a local or cloud MongoDB, go [here](../README.md) first before proceding.
3+
> If you have not set-up either a local or cloud MongoDB, go [here](../) first before proceding.
44
55
## Setting-up Firebase
66

@@ -38,7 +38,7 @@
3838
- `FIREBASE_CLIENT_EMAIL` is the value of `client_email` found in the downloaded json file.
3939
- `FIREBASE_STORAGE_BUCKET` is the folder path of the Storage. It should look something like `gs://<appname>.appspot.com`.
4040

41-
## Running Question Service
41+
## Running Question Service without Docker
4242

4343
1. Follow the instructions [here](https://nodejs.org/en/download/package-manager) to set up Node v20.
4444

@@ -48,6 +48,8 @@
4848

4949
4. Run the command `npm start` to start the Question Service in production mode, or use `npm run dev` for development mode, which includes features like automatic server restart when you make code changes.
5050

51-
5. To view Question Service documentation, go to http://localhost:3000/docs.
51+
## After running
5252

53-
6. Using applications like Postman, you can interact with the Question Service on port 3000. If you wish to change this, please update the `.env` file.
53+
1. To view Question Service documentation, go to http://localhost:3000/docs.
54+
55+
2. Using applications like Postman, you can interact with the Question Service on port 3000. If you wish to change this, please update the `.env` file.

backend/user-service/README.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# User Service Guide
22

3-
> If you have not set-up either a local or cloud MongoDB, go [here](../README.md) first before proceding.
3+
> If you have not set-up either a local or cloud MongoDB, go [here](../) first before proceding.
44
55
## Setting-up
66

@@ -10,7 +10,7 @@
1010

1111
3. 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.
1212

13-
## Running User Service
13+
## Running User Service without Docker
1414

1515
1. Follow the instructions [here](https://nodejs.org/en/download/package-manager) to set up Node v20.
1616

@@ -20,6 +20,8 @@
2020

2121
4. Run the command `npm start` to start the User Service in production mode, or use `npm run dev` for development mode, which includes features like automatic server restart when you make code changes.
2222

23-
5. To view User Service documentation, go to http://localhost:3001/docs.
23+
## After running
2424

25-
6. Using applications like Postman, you can interact with the User Service on port 3001. If you wish to change this, please update the `.env` file.
25+
1. To view User Service documentation, go to http://localhost:3001/docs.
26+
27+
2. Using applications like Postman, you can interact with the User Service on port 3001. If you wish to change this, please update the `.env` file.

0 commit comments

Comments
 (0)