chore(repo): add docker compose instructions (#240)

revertinc · Sep 11, 2023 · 4d35cd0 · 4d35cd0 · vercel · Sep 11, 2023
1 parent debf460
commit 4d35cd0
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 4 deletions.
diff --git a/.env.example b/.env.example
@@ -1,2 +1,2 @@
-SERVER_PORT=
-PGSQL_URL=
+SERVER_PORT=4001
+PGSQL_URL=postgresql://postgres:password@localhost:5432/postgres
diff --git a/README.md b/README.md
@@ -95,8 +95,16 @@ This repo contains a set of packages under `@reverdotdev/` namespace such as:
 The easiest way to start Revert is to run it via docker-compose:
 
 ```shell
-# In the root directory run
-docker-compose up
+# Get the code
+git clone --depth 1 https://github.com/revertinc/revert
+
+# Copy the example env file
+cp .env.example .env
+
+# Update this .env file with your own secrets
+
+# Then In the root directory run
+docker-compose up -d
 ```
 
 The UI is now available at http://localhost:3000 and the backend is available at http://localhost:4001.