Skip to content

Commit

Permalink
Merge pull request #43 from Ram-tyagi/main
Browse files Browse the repository at this point in the history
feat: A new feature (Contributers added in readme)
  • Loading branch information
piyushgarg-dev authored Oct 12, 2023
2 parents 4bdda7d + f9dcf61 commit 6232947
Showing 1 changed file with 20 additions and 11 deletions.
31 changes: 20 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,11 @@
# Review App - Backend Repo

This repository contains the backend code for the Review App project.

[![Screenshot-86.png](https://i.postimg.cc/pXzH9rcC/Screenshot-86.png)](https://postimg.cc/9rmSKmhw)

##### This project is divided into two repositories:

1. [Review App Frontend](https://github.com/piyushgarg-dev/review-app)
2. Review App Backend (You are here)

Expand All @@ -12,19 +15,19 @@ 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`
c. Install and Setup Docker
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`
a. Clone the Repo : `git clone https://github.com/piyushgarg-dev/review-app-api.git`
b. Move to backend foler : `cd review-app-api`
c. Install and Setup Docker
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

3. The `.env.local` file should consist of :

`DATABASE_URL=postgresql://postgres:password@localhost:5432/review
JWT_SECRET=superman123`
`DATABASE_URL=postgresql://postgres:password@localhost:5432/review
JWT_SECRET=superman123`

4. Run Migrations by running command : `yarn migrate:latest`

Expand All @@ -36,8 +39,8 @@ CONGRATULATIONS! your backend starts running on http://localhost:8000/local/grap

If you have any questions, need clarifications, or want to discuss ideas, feel free to reach out through the following channels:

- [Discord Server](https://discord.com/invite/YuUjtrufmT)
- [X(formerly Twitter)](https://twitter.com/piyushgarg_dev)
- [Discord Server](https://discord.com/invite/YuUjtrufmT)
- [X(formerly Twitter)](https://twitter.com/piyushgarg_dev)

We appreciate your contributions and look forward to working with you to make this project even better!

Expand All @@ -47,4 +50,10 @@ 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>

## Thanks To All Our Contributors

<a href="https://github.com/piyushgarg-dev/review-app-api/graphs/contributors">
<img src="https://contrib.rocks/image?repo=piyushgarg-dev/review-app-api" />
</a>

0 comments on commit 6232947

Please sign in to comment.