From 370d1a0296af8b9ef01ea0ad4eb59596ccc3b7a1 Mon Sep 17 00:00:00 2001 From: Riccardo Date: Sat, 5 Aug 2023 19:56:07 +0200 Subject: [PATCH] chore: update README.md --- README.md | 22 ++++++++++++++++++++-- 1 file changed, 20 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index e44f8a6..e848f91 100644 --- a/README.md +++ b/README.md @@ -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://:@:/` +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://:@:/` ## 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: " --no-verify` + +To run it using Docker, running the server on port 3000: + +`docker-compose up --build`