From 4385661b660b5a0a6e39c405c140fa479a8d75a1 Mon Sep 17 00:00:00 2001 From: Smith Ellis Date: Tue, 27 Aug 2024 11:35:33 -0400 Subject: [PATCH] Add docker developer section to README --- README.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/README.md b/README.md index 70b168a..de2b237 100644 --- a/README.md +++ b/README.md @@ -28,6 +28,23 @@ Finally use [gulp](http://gulpjs.com/) to check in all main static files and run gulp +## Development with Docker + +After cloning this repo, you need to create an .env file. Make a copy of .env-dist named .env. + + cp .env-dist .env + +Now docker compose from the root directory of the repo + + docker compose up + +Since this is Django, you will need to create a superuser for your dev work. Do this by attaching to the web container and running the command. + + docker compose exec web bash + ./manage.py createsuperuser + +You should now be able to login at /admin/ + ## CI & CD This application is currently run through integration and deploy pipelines via both [GitHub Actions](https://github.com/mozilla/mozmoderator/actions/workflows/ci.yaml) & a background Kubernetes [Flux](https://fluxcd.io/) setup leveraging [Helm Charts](github.com/mozilla-it/helm-charts/).