A Django 1.11 project boilerplate/template with lots of state of the art libraries and tools like:
- React, for building interactive UIs
- django-js-reverse, for generating URLs on JS
- Bootstrap 4, for responsive styling
- Webpack, for bundling static assets
- Celery, for background worker tasks
- WhiteNoise with brotlipy, for efficient static files serving
- prospector and ESLint with pre-commit for automated quality assurance (does not replace proper testing!)
For continuous integration, a CircleCI configuration circle.yml is included.
Also, includes a Heroku app.json and a working Django production.py settings, enabling easy deployments with 'Deploy to Heroku' button. Those Heroku plugins are included in app.json:
- PostgreSQL, for DB
- Redis, for Celery
- Sendgrid, for e-mail sending
- Papertrail, for logs and platform errors alerts (must set them manually)
- Opbeat, for performance monitoring
This is a good starting point for modern Python/JavaScript web projects.
- Start your project using:
django-admin startproject theprojectname --extension py,yml,json --name Procfile,README.md,.env.example --template=https://github.com/vintasoftware/django-react-boilerplate/archive/boilerplate-release.zip
- Above: don't forget the
--extensionand--nameparams! -
pip install -r requirements-to-freeze.txt -
pip freeze > requirements.txt -
npm update --save -
npm update --save-dev - Check for outdated npm dependencies with
npm outdatedand update them - Change the first line of README to the name of the project
- Add an email address to the
ADMINSsettings variable - Change the
SERVER_EMAILto the email address used to send e-mails.
After completing ALL of the above, remove this Project bootstrap section from the project README. Then follow Running below.
- On project root, do the following:
- Create a copy of
{{project_name}}/settings/local.py.example:
cp {{project_name}}/settings/local.py.example {{project_name}}/settings/local.py - Create a copy of
.env.example:
cp .env.example .env - Create the migrations for
usersapp (do this, then remove this line from the README):
python manage.py makemigrations - Run the migrations:
python manage.py migrate
- Setup editorconfig, prospector and ESLint in the text editor you will use to develop.
pip install -r requirements.txtnpm installnpm run startpython manage.py runserver
make test
Will run django tests using --keepdb and --parallel. You may pass a path to the desired test module in the make command. E.g.:
make test someapp.tests.test_views
Add high level dependecies to requirements-to-freeze.txt and pip freeze > requirements.txt. This is A Better Pip Workflow.
- Manually with
prospectorandnpm run linton project root. - During development with an editor compatible with prospector and ESLint.
- Run
pre-commit installto enable the hook into your git repo. The hook will run automatically for each commit. - Run
git commit -m "Your message" -nto skip the hook if you need.
If you made changes to this boilerplate and want to test them, commit your changes and use git archive -o boilerplate.zip HEAD to create the template zip. Then, do a cd .. and a django-admin startproject theprojectname --extension py,yml,json --name Procfile,README.md,.env.example --template=django-react-boilerplate/boilerplate.zip to test the project bootstrap.
Push your changes to a branch and visit https://dashboard.heroku.com/new?template=https://github.com/fill-org-or-user/fill-project-repo-name/tree/fill-branch (replace all fill-*).
Read this.
P.S. if you want to deploy in a different way please check the app.json file for what needs to be configured.
This project, as other Vinta open-source projects, is used in products of Vinta clients. We are always looking for exciting work, so if you need any commercial support, feel free to get in touch: [email protected]
Copyright (c) 2017 Vinta Serviços e Soluções Tecnológicas Ltda. MIT License