docs: add env variable info

AmbossTech · Jul 4, 2024 · f77a1a7 · f77a1a7
1 parent 5ae4bc7
commit f77a1a7
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 2 deletions.
diff --git a/.env.example b/.env.example
@@ -0,0 +1,3 @@
+URL=
+SERVER_URL=
+EVENTS_URL=
diff --git a/README.md b/README.md
@@ -9,8 +9,9 @@ This is the frontend of the Banco tech stack which can be self-hosted.
 1. `git clone` the repo
 2. `cd` into the directory
 3. install packages with `npm install` (using node `v20.11.1`)
-4. `yarn dev` or `npm run dev`
-5. app opens on `localhost:3000`
+4. `cp .env.example .env.local` (and setup env variables)
+5. `yarn dev` or `npm run dev`
+6. app opens on `localhost:3000`
 
 ## Build for production