Skip to content

Commit 4446e92

Browse files
committed
Make minor change to README
1 parent 6c0754e commit 4446e92

File tree

1 file changed

+17
-16
lines changed

1 file changed

+17
-16
lines changed

backend/question-service/README.md

Lines changed: 17 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -22,29 +22,31 @@
2222

2323
5. In the `question-service` directory, create a copy of the `.env.sample` file and name it `.env`.
2424

25-
6. Update the `MONGO_URI` of the `.env` file, and paste the string we copied earlier in step 4.
25+
6. Update the `MONGO_URI` of the `.env` file, and paste the string we copied earlier in step 4.
2626

2727
## Setting-up Firebase
2828

2929
1. Go to https://console.firebase.google.com/u/0/.
3030

3131
2. Create a project and choose a project name. Navigate to `Storage` and click on it to activate it.
3232

33-
3. Select `Start in production mode` and your preferred cloud storage region.
33+
3. Select `Start in production mode` and your preferred cloud storage region.
3434

3535
4. After Storage is created, go to `Rules` section and set rule to:
36-
```
37-
rules_version = '2';
38-
service firebase.storage {
39-
match /b/{bucket}/o {
40-
match /{allPaths=**} {
41-
allow read: if true;
42-
allow write: if request.auth != null;
43-
}
44-
}
45-
}
46-
```
47-
This rule ensures that only verified users can upload images while ensuring that URLs of images are public. Remember to click `Publish` to save changes.
36+
37+
```
38+
rules_version = '2';
39+
service firebase.storage {
40+
match /b/{bucket}/o {
41+
match /{allPaths=**} {
42+
allow read: if true;
43+
allow write: if request.auth != null;
44+
}
45+
}
46+
}
47+
```
48+
49+
This rule ensures that only verified users can upload images while ensuring that URLs of images are public. Remember to click `Publish` to save changes.
4850

4951
5. Go to `Settings`, `Project settings`, `Service accounts` and click `Generate new private key`. This will download a `.json` file, which will contain your credentials.
5052

@@ -54,7 +56,6 @@
5456
- `FIREBASE_CLIENT_EMAIL` with `client_email` found in the downloaded json file.
5557
- `FIREBASE_STORAGE_BUCKET` with the folder path of the Storage. It should look something like `gs://<appname>.appspot.com`.
5658

57-
5859
## Running Question Service
5960

6061
1. Open Command Line/Terminal and navigate into the `question-service` directory.
@@ -63,6 +64,6 @@
6364

6465
3. 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.
6566

66-
4. To view Question Service documentation, go to http://localhost:3001/docs.
67+
4. To view Question Service documentation, go to http://localhost:3000/docs.
6768

6869
5. 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.

0 commit comments

Comments
 (0)