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.

Sign up for GitHub

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: Updating readme file #53

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: Updating readme file #53

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
28 changes: 28 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,10 @@ For more information about the project, visit the [frontend repository](https://
5. Set up the backend by running the following command:
```shell
yarn

#or

npm install
```

### Create a `.env.local` file in the project's root directory.
Expand All @@ -59,8 +63,28 @@ JWT_SECRET=superman123

Run database migrations with the following command:

**For First-Time Setup:**

Use this command to perform local database migration when starting the project for the first time. It initializes the database.

```shell
yarn prisma:migrate:local

#or

npm run prisma:migrate:local
```

**For Subsequent Migrations:**

Use this command for applying the latest database migrations once the project is already set up. It updates the database schema.

```shell
yarn migrate:latest

#or

npm run migrate:latest
```

### Start the Backend Server:
Expand All @@ -69,6 +93,10 @@ To start the backend server, run the following command:

```shell
yarn local

#or

npm run local
```

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