chore: update README.md

This commit is contained in:
Riccardo
2023-08-05 19:56:07 +02:00
parent 69cbe53a90
commit 370d1a0296

View File

@@ -12,8 +12,10 @@ It contains basic configurations for the following:
# Environment Variables
- PORT - The port to run the server on
- `DATABASE_URL` - The URL to the database, formatted as `postgres://<username>:<password>@<host>:<port>/<database>`
Need to export the following environment variables:
- PORT - The port to run the server on (defaults to 3000)
- DATABASE_URL - The URL to the database, formatted as `postgres://<username>:<password>@<host>:<port>/<database>`
## Commands
@@ -21,6 +23,18 @@ Install dependencies:
`yarn`
Generate Prisma client:
`yarn db:generate`
Run the migrations:
`yarn db:migrate`
Reset the database:
`yarn db:reset`
Audit:
`yarn audit`
@@ -60,3 +74,7 @@ Run:
To commit a WIP skipping checks:
`git commit -m "WIP: <message>" --no-verify`
To run it using Docker, running the server on port 3000:
`docker-compose up --build`