README: added local run instructions

This commit is contained in:
Patrik Oldsberg
2020-02-07 11:46:37 +01:00
parent d9fea35c4f
commit 518decc20b
+25
View File
@@ -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