Cookiecutter Django Wagtail
Cookiecutter-Django-Wagtail is a fork of the awesome Cookiecutter Django combined with Wagtail.
- Cookiecutter Django Documentation: https://cookiecutter-django.readthedocs.io/en/latest/
- Wagtail Documentation: https://docs.wagtail.io/en/stable/
- See Troubleshooting (Cookiecutter Django) for common errors and obstacles
Features
- For Django 3
- Wagtail 2.9
- Works with Python 3.8
- Renders Django projects with 100% starting test coverage
- Twitter Bootstrap v4 (maintained Foundation fork also available)
- 12-Factor based settings via django-environ
- Secure by default. We believe in SSL.
- Optimized development and production settings
- Registration via django-allauth
- Comes with custom user model ready to go
- Optional basic ASGI setup for Websockets
- Optional custom static build using Gulp and livereload
- Send emails via Anymail (using Mailgun by default or Amazon SES if AWS is selected cloud provider, but switchable)
- Media storage using Amazon S3 or Google Cloud Storage
- Docker support using docker-compose for development and production (using Traefik with LetsEncrypt support)
- Procfile for deploying to Heroku
- Instructions for deploying to PythonAnywhere
- Run tests with unittest or pytest
- Customizable PostgreSQL version
- Default integration with pre-commit for identifying simple issues before submission to code review
Optional Integrations
These features can be enabled during initial project setup.
- Serve static files from Amazon S3, Google Cloud Storage or Whitenoise
- Configuration for Celery and Flower (the latter in Docker setup only)
- Integration with MailHog for local email testing
- Integration with Sentry for error logging
Constraints
- Only maintained 3rd party libraries are used.
- Uses PostgreSQL everywhere (9.4 - 11.3)
- Environment variables for configuration (This won't work with Apache/mod_wsgi).
Usage
Instead of using Wagtail’s start command you will use Cookiecutter to set up your project. Cookiecutter will prompt you for some technical and administrative question like your name, email, and various configuration issues.
Install Cookiecutter first:
$ pip install "cookiecutter>=1.7.0"
Now run it against this repo:
$ cookiecutter https://github.com/Jean-Zombie/cookiecutter-django-wagtail/
You'll be prompted for some values. Provide them, then a Wagtail project will be created for you.
For local development, see the following:
Support Cookiecutter Django!
The upstream of this repo, i.e. Cookiecutter Django, is run by volunteers. Please support them in their efforts to maintain and improve Cookiecutter Django:
- Daniel Roy Greenfeld, Project Lead (GitHub, Patreon): expertise in Django and AWS ELB.
- Nikita Shupeyko, Core Developer (GitHub): expertise in Python/Django, hands-on DevOps and frontend experience.
Code of Conduct
Everyone interacting in the Cookiecutter project's codebases, issue trackers, chat rooms, and mailing lists is expected to follow the PyPA Code of Conduct.