Skip to content

Commit

Permalink
Update README to be more specific
Browse files Browse the repository at this point in the history
  • Loading branch information
ryanchua00 committed Nov 16, 2023
1 parent 7a7c288 commit 5867312
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 5 deletions.
18 changes: 15 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,26 @@
# Getting Started with Docker for Development
This will help you set up your local environment to run PeerPrep. Note that if you have received `.env` files for frontend, question and user services, simply add those files to the respective `frontend`, `backend/user-service` and `mongodb-database` directories and rename them to `.env`. Thereafter, skip step 3, 4 and 5.

1. Install docker at https://www.docker.com/

2. Start docker

3. Run `docker compose build` to build the images and containers
3. Enter the `backend/user-service` directory and follow the `README.md` to configure the user-service

4. Run `docker compose up` to start the container (Note: this will only start the user & question service)
4. Enter the `mongodb-database` directory and follow the `README.md` to configure the question-service

5. Note: this does not start the api-gateway. Follow the relevant `./gateway/README.md`
5. Enter the `frontend` directory and follow the `README.md` to configure the frontend

6. Run `docker compose build` from the root directory to build the images and containers

7. Run `docker compose up` from the root directory to start the container
(Note: this will only start the user & question service)

8. Enter the `frontend` directory and run `npm install`, followed by `npm run dev`.

9. Enter the `gateway` directory and run `npm install`, followed by `npm start`.

10. Visit http://localhost:3000 and create an account

## Developer guide

Expand Down
4 changes: 2 additions & 2 deletions gateway/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Getting Started with Express API Gateway

1. Use command `npm install -g express-gateway` to install express gateway on your system.
1. Use command `npm install` to install express gateway on your system.

2. Enter the gateway directory and run `npm start` to start the api gateway server.
2. Run `npm start` to start the api gateway server.

0 comments on commit 5867312

Please sign in to comment.