Author: Filip Vavera
TODO: describe application
- Install Docker and docker-compose.
- Create your application settings
cp example.env .env
(you can leave everything default) - Download latest images
docker-compose pull
- Build the application Docker image
docker-compose build --pull
- Run the application
docker-compose up
- If you encounter bug that Postgres DB takes longer to start so Django
fails to connect to it in separate terminal run
docker-compose exec django python manage.py runserver 0.0.0.0:8000
- You can fix the bug by editting
scripts/start-dev.sh
file where you wait until the DB is reachable and starting the Django after that
- If you encounter bug that Postgres DB takes longer to start so Django
fails to connect to it in separate terminal run
- Initialize your database
docker-compose exec django python manage.py migrate
- Create superuser account
docker-compose exec django python manage.py createsuperuser
- Enjoy application running on
http://localhost:8000
(you can login with your newly created account into administration athttp://localhost:8000/admin/
)
- Install
pipenv
- Create your new Python environment
pipenv install
- Run the application as described in Run locally section
- Edit code in your favourite Python editor (Vim is the only correct answer)
- Prepare your environment as described in previous section
- Run tests
pipenv run pytest
TODO: describe deployment here