Skip to content
This repository has been archived by the owner on Apr 12, 2020. It is now read-only.

ahlsunnah/learn-islam-django

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Learn Islam django

Current CircleCI build status. Built with Cookiecutter Django Black code style

Start developing with docker

Before starting you will need to install docker and docker-compose to your computer

Build and start

export COMPOSE_FILE=local.yml
docker-compose build
docker-compose up -d

After that you can run commands in the container

# Run a bash terminal inside the app's container
dc exec django bash
# Run pytest
dc exec django pytest
# Run a python shell inside the app
dc exec django ./manage.py shell_plus
# Create a super user
dc exec django ./manage.py createsuperuser
# Run migrations
dc exec django ./manage.py migrate
# Create migrations
dc exec django ./manage.py makemigrations
# Create an empty migration
dc exec django ./manage.py makemigrations --empty tracks

Test coverage

To run the tests, check your test coverage, and generate an HTML coverage report:

$ coverage run -m pytest
$ coverage html
$ open htmlcov/index.html

Celery

This app comes with Celery.

To run a celery worker:

cd learn_islam
celery -A config.celery_app worker -l info

Please note: For Celery's import magic to work, it is important where the celery commands are run. If you are in the same folder with manage.py, you should be right.

Email Server

In development, it is often nice to be able to see emails that are being sent from your application. For that reason local SMTP server MailHog with a web interface is available as docker container.

Container mailhog will start automatically when you will run all docker containers. Please check cookiecutter-django Docker documentation for more details how to start all containers.

With MailHog running, to view messages that are sent by your application, open your browser and go to http://127.0.0.1:8025

Sentry

Sentry is an error logging aggregator service. You can sign up for a free account at https://sentry.io/signup/?code=cookiecutter or download and host it yourself. The system is setup with reasonable defaults, including 404 logging and integration with the WSGI application.

You must set the DSN url in production.

Deployment

The following details how to deploy this application.

Heroku

See detailed cookiecutter-django Heroku documentation.

Docker

See detailed cookiecutter-django Docker documentation.