From 9808ef3df9301dd159ceb7f89f97960c050bc1e7 Mon Sep 17 00:00:00 2001 From: MTG2000 Date: Sun, 25 Sep 2022 12:12:15 +0300 Subject: [PATCH] update: add DB env vars to README --- README.md | 16 +++++++++++++--- 1 file changed, 13 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index fb90840..cccaa25 100644 --- a/README.md +++ b/README.md @@ -32,9 +32,19 @@ We are using serverless functions to serve our GraphQl endpoint to the client ap ## Running locally -First, you need to have a Postegre Database to store the data, then you need to put the connection string in an .env file in your project root directory. -The connection string will be of the format: -postgresql://username:password@server/database_name +To run the project locally with your own local DB, you will need to first put a few env variables in an env file that should be created in /envs/server directory, named `local.env` + +The required variables that needs to be put there are: + +``` +NODE_ENV = "development" +DATABASE_PROXY_URL = "YOUR DB CONNECTION STRING" +JWT_SECRET = "SOME RANDOM JWT SECRET" +LNURL_AUTH_HOST = "http://localhost:8888/dev/login" +CLOUDFLARE_IMAGE_ACCOUNT_ID = "FOR UPLOADING IMAGES" +CLOUDFLARE_IMAGE_API_KEY = "FOR UPLOADING IMAGES" +CLOUDFLARE_IMAGE_ACCOUNT_HASH = "FOR UPLOADING IMAGES" +``` Then you need to run the migrations against your database. use the command: