Upgrade README.md

Author: Ivaylo-Bachvarov

README.md

@@ -20,7 +20,8 @@ Few important things:
 * It comes with GitHub Actions support, [based on that article](https://hacksoft.io/github-actions-in-action-setting-up-django-and-postgres/)
 * It comes with examples for writing tests with fakes & factories, based on the following articles - <https://www.hacksoft.io/blog/improve-your-tests-django-fakes-and-factories>, <https://www.hacksoft.io/blog/improve-your-tests-django-fakes-and-factories-advanced-usage>
 * It comes with [`whitenoise`](http://whitenoise.evans.io/en/stable/) setup.
-* It can be easily deployed to Heroku.
+* It can be easily deployed to Heroku or AWS ECS.
+* Dockerized for local development with docker-compose.
 * It comes with an example list API, that uses [`django-filter`](https://django-filter.readthedocs.io/en/stable/) for filtering & pagination from DRF.
 * It comes with [`mypy`](https://mypy.readthedocs.io/en/stable/) configured, using both <https://github.com/typeddjango/django-stubs> and <https://github.com/typeddjango/djangorestframework-stubs/>
   * Basic `mypy` configuration is located in [`setup.cfg`](setup.cfg)
@@ -201,7 +202,7 @@ Example data structure:
 }
 ```
 
-## Helpful commands
+## Helpful commands for local development without docker-compose
 
 To create Postgres database:
 
@@ -227,6 +228,25 @@ To start Celery Beat:
 celery -A styleguide_example.tasks beat -l info --scheduler django_celery_beat.schedulers:DatabaseScheduler
 ```
 
+## Helpful commands for local development with docker-compose
+To build and run everything
+
+```
+docker-compose up
+```
+
+To run migrations
+
+```
+docker-compose run django python manage.py migrate
+```
+
+To shell
+
+```
+docker-compose run django python manage.py shell
+```
+
 ## Heroku
 
-The project is ready to be deployed on Heroku. There's a current deployment that can be found - <https://hacksoft-styleguide-example.herokuapp.com/>
+The project is ready to be deployed on Heroku. There's a current deployment that can be found - <https://hacksoft-styleguide-example.herokuapp.com/>

docker-compose.yml

@@ -29,7 +29,7 @@ services:
     build:
       context: .
       dockerfile: docker/local.Dockerfile
-    command: celery --app=styleguide_example.tasks.celery worker --without-gossip --without-heartbeat --without-mingle --loglevel=info
+    command: celery -A styleguide_example.tasks worker -l info --without-gossip --without-mingle --without-heartbeat
     environment:
       - DATABASE_URL=postgres://postgres:postgres@db:5432/styleguide_example_db
       - CELERY_BROKER_URL=redis://redis
@@ -44,7 +44,7 @@ services:
     build:
       context: .
       dockerfile: docker/local.Dockerfile
-    command: celery --app=styleguide_example.tasks.celery beat --loglevel=info
+    command: celery -A styleguide_example.tasks beat -l info --scheduler django_celery_beat.schedulers:DatabaseScheduler
     environment:
       - DATABASE_URL=postgres://postgres:postgres@db:5432/styleguide_example_db
       - CELERY_BROKER_URL=redis://redis

docker/beats_entrypoint.sh

@@ -0,0 +1,2 @@
+echo "--> Starting beats process"
+celery -A styleguide_example.tasks worker -l info --without-gossip --without-mingle --without-heartbeat

docker/celery_entrypoint.sh

@@ -0,0 +1,2 @@
+echo "--> Starting celery process"
+celery -A styleguide_example.tasks beat -l info --scheduler django_celery_beat.schedulers:DatabaseScheduler

docker/local.Dockerfile

@@ -1,3 +1,4 @@
+# This docker file is used for local development via docker-compose
 # Creating image based on official python3 image
 FROM python:3.9.4
 

docker/production.Dockerfile

@@ -1,3 +1,4 @@
+# This docker file is used for production
 # Creating image based on official python3 image
 FROM python:3.9.4
 

docker/web_entrypoint.sh

@@ -1,2 +1,2 @@
-echo "--> Starting web app"
-gunicorn config.wsgi:application -b 0.0.0.0:80
+echo "--> Starting web process"
+gunicorn config.wsgi:application -b 0.0.0.0:80