Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Update README.md #31

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 8 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,15 @@ Go to [this repository](https://github.com/piyushgarg-dev/review-app) to know mo
1. Pre-requisites :

a. Clone the Repo : `git clone https://github.com/piyushgarg-dev/review-app-api.git`
b. Move to backend foler : `cd review-app-api`

b. Move to backend folder : `cd review-app-api`

c. Install and Setup Docker
d. Run Docker in background

d. Run Docker in background

e. Run this command to run "docker-compose.yml" file in detach mode : `docker compose up -d`

f. Setup Backend by running command : `yarn`

2. Create a `.env.local` file in the project's root directory
Expand Down Expand Up @@ -47,4 +52,4 @@ We appreciate your contributions and look forward to working with you to make th
<a href="https://github.com/piyushgarg-dev/review-app-api/graphs/contributors">
<img src="https://contrib.rocks/image?repo=piyushgarg-dev/review-app-api&anon=1" />
</a>
</div>
</div>
Loading