/review-app-api

Backend Review Management Application | https://youtu.be/JD3NQsB3TQI

Primary LanguageTypeScriptGNU General Public License v3.0GPL-3.0

Review App - Backend Repo

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

Screenshot-86.png

Please Note: This project is divided into two repositories:

  1. Review App Frontend
  2. Review App Backend (You are here)

For more information about the project, visit the frontend repository.

Environment Setup:

Prerequisites:

  1. Clone the repository:

    git clone https://github.com/piyushgarg-dev/review-app-api.git
  2. Move to the backend folder:

    cd review-app-api
  3. Install and set up Docker.

  4. Run Docker in the background. If you have an older version of Docker, use the following command to run the docker-compose.yml file in detached mode:

    docker-compose up -d

    Otherwise, run:

    docker compose up -d
  5. Set up the backend by running the following command:

    yarn

Create a .env.local file in the project's root directory.

The .env.local file should contain the following environment variables:

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

Run Migrations:

Run database migrations with the following command:

yarn migrate:latest

Start the Backend Server:

To start the backend server, run the following command:

yarn local

Congratulations! Your backend is now running at http://localhost:8000/local/graphql.

Communication Channels:

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

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

Best Contributors:

Thanks To All Our Contributors: