Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/thorgate/django-project-template
Thorgate's Django project template - Django, React, Sass, optional Docker and more
https://github.com/thorgate/django-project-template
cookiecutter django docker docker-compose javascript react template webpack
Last synced: about 3 hours ago
JSON representation
Thorgate's Django project template - Django, React, Sass, optional Docker and more
- Host: GitHub
- URL: https://github.com/thorgate/django-project-template
- Owner: thorgate
- License: isc
- Created: 2016-03-28T15:10:57.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2024-08-29T14:23:28.000Z (3 months ago)
- Last Synced: 2024-08-30T13:08:07.183Z (3 months ago)
- Topics: cookiecutter, django, docker, docker-compose, javascript, react, template, webpack
- Language: JavaScript
- Homepage:
- Size: 2.69 MB
- Stars: 123
- Watchers: 15
- Forks: 16
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# Thorgate's Django template
[](https://gitlab.com/thorgate-public/django-project-template/commits/master)
[Django](https://www.djangoproject.com/) project template that we use at [Thorgate](https://thorgate.eu).
Best suited for medium-sized and bigger apps that use JavaScript and React for frontend or single page web applications.
_(note that the primary repo is in [Gitlab](https://gitlab.com/thorgate-public/django-project-template), with mirror in [Github](https://github.com/thorgate/django-project-template))_
## Features
- Django-based backend
- [Django](https://www.djangoproject.com/)
- Separate settings for different environments (local/staging/production)
- Python 3.6 or later
- [SPA] Accessible from port `3000` for local development
- Frontend app with JavaScript (ES2015), React and Sass
- Latest JavaScript features from [ES2015](https://babeljs.io/docs/learn-es2015/) and beyond, transpiled with
[Babel](https://babeljs.io/)
- [React](https://facebook.github.io/react/) for fast modular user interfaces
- [Sass](http://sass-lang.com/), [PostCSS](http://postcss.org/) and
[Autoprefixer](https://github.com/postcss/autoprefixer) for more convenient styling
- [Webpack](https://webpack.github.io/) is used to bundle and minify JavaScript and styles
- [SPA] [Razzle](https://razzlejs.org/) for preconfigured isomorphic application
- [SPA] Accessible from port `8000` for local development
- Batteries
- Docker / Docker Compose integration
- Linting of Python, JavaScript and Sass code with [Prospector](http://prospector.landscape.io/),
[ESLint](http://eslint.org/) and [stylelint](https://stylelint.io/)
- Automated code-formatting using [black](https://black.readthedocs.io) and [prettier](https://prettier.io)
- [py.test](http://pytest.org/) and [coverage](https://coverage.readthedocs.io/) integration
- Deploy helpers, using [Ansible](https://www.ansible.com/)
- Media files are stored in a CDN like S3 or Google Cloud Storage
- Out-of-the-box configuration for nginx, gunicorn and logrotate
- Includes [PyCharm](https://www.jetbrains.com/pycharm/) project config
## Usage
To use this template, first ensure that you have
[Poetry](https://python-poetry.org/docs/) available.
After that, you should:
1. Install the requirements of the project template by running
```
poetry install
```
2. Activate the virtualenv created by _poetry_:
```
poetry shell
```
3. Navigate to the directory where you'd like to create your project:
```
cd /home/my-awesome-projects/
```
4. Create a new project by executing:
```
cookiecutter dir/to/django-project-template/
```
It will ask you a few questions, e.g. project's name, python version and so on. **For a reference of all the configuration options** see [CookiecutterVariables.md](./CookiecutterVariables.md) file.
To create isomorphic single-page application set `frontend_style == spa`. Then separate node application will be created supported by [Razzle](https://razzlejs.org/)
After generation completes, **you should deactivate virtual environment for cookiecutter**,
search for any TODOs in the code and make appropriate changes where needed.
See README.md in the generated project for instructions on how to set up your development environment.
## Different frontend styles
### SPA
Isomorphic Javascript single-page application rendered with node and backed by Django Rest Framework. Enabled with `frontend_style == spa`.
During development and production separate node container is used to run and serve assets if needed.
Translations are done with [i18next](https://www.i18next.com/) and its companion library for React.
### Webapp
React powered application rendered with Django templates. This is the default option. Enabled with `frontend_style == webapp`.
During development separate container is used to build assets. In production, node built with multi-stage image.
Translations are done with Django JavaScriptCatalog.
## Upgrading project template
First ensure you have a python3 interpreter with `cookiecutter` installed.
To upgrade an existing project, change the current working directory to the root of the project you want to upgrade. i.e. `cd project-to-upgrade`. Ensure your have not checked out the `template` branch.
Then run `python ~/path/to/django-project-template/upgrade-template.py`
This will make a commit to the branch `template` in your project with the updates to the project template. Then merge the `template` branch.
## Applying codemods
First activate Python 3 interpreter with required dependencies and ensure `docker` is installed and working.
Change the current working directory to the root of the project you want to apply codemods for. i.e. `cd project-to-upgrade`.
Then run `python ~/path/to/django-project-template/upgrade-template.py --apply-frontend-codemods`
This will build custom docker image to update old frontend versions.
## Docker images
The template uses our own images for CI runs. One for the template itself and a second one
for generated projects. Both images are alpine based and contain python3, pip and some support
packages. The images are published to [repository container registry](https://gitlab.com/thorgate-public/django-project-template/container_registry) and also to [docker hub](https://hub.docker.com/u/thorgate).
The images are built in CI (from default branches only) and also updated every day via schedules.
**Project CI Image**
- [Dockerfile-ci](./utils/Dockerfile-ci)
- Image in repository registry: `registry.gitlab.com/thorgate-public/django-project-template/ci`
- Image in docker hub: `thorgate/django-template-ci`
- [see online](https://hub.docker.com/r/thorgate/django-template-ci)
**Template CI Image:**
- [Dockerfile-base-ci](./utils/Dockerfile-base-ci)
- Image in repository registry: `registry.gitlab.com/thorgate-public/django-project-template/base-ci`
- Image in docker hub: `thorgate/django-template-base-ci`
- [see online](https://hub.docker.com/r/thorgate/django-template-base-ci)