Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/eon01/django-boilerplate
An opinionated Django boilerplate running Celery & Django on the same Docker container and ready to run on Docker Compose & Kubernetes.
https://github.com/eon01/django-boilerplate
boilerplate django docker docker-compose dockerfile kubernetes python
Last synced: 2 months ago
JSON representation
An opinionated Django boilerplate running Celery & Django on the same Docker container and ready to run on Docker Compose & Kubernetes.
- Host: GitHub
- URL: https://github.com/eon01/django-boilerplate
- Owner: eon01
- Created: 2020-05-09T14:00:08.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-02-29T16:00:02.000Z (11 months ago)
- Last Synced: 2024-10-28T15:42:29.119Z (3 months ago)
- Topics: boilerplate, django, docker, docker-compose, dockerfile, kubernetes, python
- Language: JavaScript
- Homepage:
- Size: 2.48 MB
- Stars: 38
- Watchers: 4
- Forks: 1
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Django Boilerplate
An opinionated Django boilerplate running Celery and Django on the same Docker container and ready to run on Kubernetes.
## Features
- Docker Compose
- Kubernetes manifests
- Postgres as the default database
- A Dockerfile for each service
- Static files on S3 and CloudFront using Django Storages.
- A .env file for each service
- A base settings file with a separation between dev and prod environments
- Configured to run Celery on the same container as Django using s6-overlay
- Configured to run Redis in a separate container
- Cache configured and ready to run on disk and using Redis
- WSGI configured using gunicorn
- Commons libraries are installed:
- Collectfast
- django-health-check
- django-select2
- django_extensions
- django-clear-cache
- django-taggit
- django-crispy-forms
- django-debug-toolbar
- sorl-thumbnail
- django-css-inline
- django-storages
- django-redis
- django-celery-beat
- django-rest-framework
## How to use
0 - Grab a coffee.
1 - Install, Docker and Docker Compose.
2 - **Important**: Activate your virtual env if you are using one.
```bash
mkvirtualenv
```
3 - Clone/checkout and run:
```bash
# clone the project
git clone https://github.com/eon01/django-boilerplate
# checkout to the branch you want to use (don't use the master branch)
git checkout django-4.2.10
# cd into the project and run the init.sh script
cd
# run the init.sh script
bash init.sh
```
4 - Update the .env file located at the root of the project with your own environment variables.
```bash
vi /.env
```
5 - Run Compose:
```bash
docker compose up --build
```
## How to deploy to K8s
Start by creating the namespace:
```bash
kubectl apply -f kubernetes/ns.yaml
```
This is how to deploy using envsubst:
```bash
export image=me/my-image:v0.01
envsubst < kubernetes/$app.yaml | kubectl apply -f - && echo "$image" >> last.txt
```
A single line to create a tag (e.g: v0.0.1), build the image (e.g: gcr.io/my-project/my-app:0.0.1), push to a registry (e.g: gcr) and deploy to K8s:
```bash
export v=0.0.1 && export app=my-app && export repos=gcr.io/my-project/$app && export image=$repos:$v && git add . && git commit -m "v$v"; git tag -a v$v -m "Version $v" && git push origin --tags && docker build $app/ -t $image -f $app/Dockerfile && docker push $image && envsubst < kubernetes/$app.yaml | kubectl apply -f - && echo "$image" >> last.txt
```
(You need to delete the tag if it exists: `git tag -d v0.0.1 && git push --delete origin v0.0.1`)
## Contribution
All contributions are welcome.