Add details about Makefile to DEVELOPER.md
This commit is contained in:
parent
db5c34f3b7
commit
8fb8adb315
1 changed files with 40 additions and 0 deletions
40
DEVELOPER.md
40
DEVELOPER.md
|
|
@ -2,6 +2,7 @@
|
|||
- [Code style](#code-style)
|
||||
- [Backend setup](#backend-setup)
|
||||
- [Frontend setup](#frontend-setup)
|
||||
- [Setup using Makefile](#setup-using-makefile)
|
||||
- [Slack application setup](#slack-application-setup)
|
||||
- [Update drone build](#update-drone-build)
|
||||
- [Troubleshooting](#troubleshooting)
|
||||
|
|
@ -142,6 +143,45 @@ extra_hosts:
|
|||
|
||||
```
|
||||
|
||||
### Setup using Makefile
|
||||
|
||||
- Make sure you have `make` installed
|
||||
- Backend setup:
|
||||
- Run stateful services:
|
||||
`$ make docker-services-start`
|
||||
|
||||
(you can change your preferred docker file by defining the `DOCKER_FILE` env variable)
|
||||
|
||||
- Setup environment:
|
||||
`$ make bootstrap`
|
||||
|
||||
(you can change your preferred directory for your Python virtualenv by defining the `ENV_DIR` env variable)
|
||||
|
||||
- Start the server (this will run bootstrap if needed and apply db migrations):
|
||||
`$ make run`
|
||||
|
||||
- Start the celery workers:
|
||||
`$ make start-celery`
|
||||
|
||||
- Start celery beat:
|
||||
`$ make start-celery-beat`
|
||||
|
||||
- Frontend:
|
||||
- Build and watch plugin:
|
||||
`$ make watch-plugin`
|
||||
|
||||
- Generate invitation token:
|
||||
`$ make manage ARGS="issue_invite_for_the_frontend --override"`
|
||||
|
||||
- Follow instructions above to setup plugin (see steps 5 and 6)
|
||||
|
||||
- Other useful targets:
|
||||
- `$ make shell` (open Django shell)
|
||||
- `$ make dbshell` (open DB shell)
|
||||
- `$ make test` (run tests)
|
||||
- `$ make lint` (run lint checks)
|
||||
|
||||
|
||||
### Slack application setup
|
||||
|
||||
For Slack app configuration check our docs: https://grafana.com/docs/grafana-cloud/oncall/open-source/#slack-setup
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue