From 518decc20be6a9902518c5729240b731ef9578e7 Mon Sep 17 00:00:00 2001
From: Patrik Oldsberg <poldsberg@gmail.com>
Date: Fri, 7 Feb 2020 11:46:37 +0100
Subject: [PATCH] README: added local run instructions

---
 README.md | 25 +++++++++++++++++++++++++
 1 file changed, 25 insertions(+)

diff --git a/README.md b/README.md
index 7a8c78ecf4..f5f2898442 100644
--- a/README.md
+++ b/README.md
@@ -18,6 +18,31 @@ $ prototool generate ./proto
 
 See [proto/README.md](proto/README.md) for more information.
 
+## Running Locally
+
+First step is to set up a `secrets.env` file in the root of the repo. Use the following template but fill in your own values:
+
+```bash
+# Github Access token with repo scope, created at https://github.com/settings/tokens
+BOSS_GH_ACCESS_TOKEN=<access-token>
+```
+
+Then run start all backend services using `docker-compose`:
+
+```bash
+$ ./docker-compose.yaml up --build
+```
+
+And finally install all dependencies and start serving the frontend using `yarn`:
+
+```bash
+$ cd frontend
+
+$ yarn install
+
+$ yarn start
+```
+
 ## Plugins
 
 ### Creating a Plugin