docker-django-boilerplate

KO | EN

gitlite — search

#python #cpp #php #hacktoberfest #game #javascript #rust #react #lua #android #pytorch #windows

docker-django-boilerplate

★ 47 Open GitHub ↗

Minimal boilerplate setup for a Django project with Docker.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Docker Django Boilerplate

Minimal setup for a Django project with Docker, following 
[the 12factor app](https://12factor.net/) principles. This repo contains 
skeleton code to get up and running with Docker & Django quickly. The 
image uses [uWSGI](https://uwsgi-docs.readthedocs.io/) to host the 
Django project. It's up to you to put Nginx or Apache in front in 
production.

This image is **not intended** as being a base image for a Django project.
It's a boilerplate, you can copy/paste this and use it as a base to 
start a project. The image contains the *hello* Django project. 
[Replace the word *hello* with the name of *your project*](docs/rename.md).

## Usage

Download the repository:
```
$ git clone https://github.com/lukin0110/docker-django-boilerplate.git
```

Init project:
```
$ cd docker-django-boilerplate
$ docker-compose build
```

Setup database:
```
$ docker-compose up -d postgres
$ docker-compose run app setup_db
```

Launch:
```
$ docker-compose up app
```

Launch Nginx *(optional)*:
```
$ docker-compose up web
```

*Now your django app is available on http://localhost, but it's optional for development*

## Container commands

The image has

Run a command:
```
$ docker-compose run app <command>
```

Available commands:

| Command   | Description                                                                     |
|-----------|---------------------------------------------------------------------------------|
| dev       | Start a normal Django development server                                        |
| bash      | Start a bash shell                                                              |
| manage    | Start manage.py                                                                 |
| setup_db  | Setup the initial database. Configure *$POSTGRES_DB_NAME* in docker-compose.yml |
| lint      | Run pylint                                                                      |
| python    | Run a python command                                                            |
| shell     | Start a Django Python shell                                                     |
| uwsgi     | Run uwsgi server                                                                |
| help      | Show this message                                                               |

### Create a Django app

```
$ docker-compose run app manage startapp myapp
```

### Create a super user
```
$ docker-compose run app manage createsuperuser
```

## Awesome resources

Useful awesome list to learn more about all the different components used in this repository.

* [Docker](https://github.com/veggiemonk/awesome-docker)
* [Django](https://gitlab.com/rosarior/awesome-django)
* [Python](https://github.com/vinta/awesome-python)
* [Nginx](https://github.com/agile6v/awesome-nginx)
* [AWS](https://github.com/donnemartin/awesome-aws)

## Useful links

* [Docker Hub Python](https://hub.docker.com/_/python/)
* [Docker Hub Postgres](https://hub.docker.com/_/postgres/)
* [Docker compose Postgres environment variables](http://stackoverflow.com/questions/29580798/docker-compose-environment-variables)
* [Quickstart: Docker Compose and Django](https://docs.docker.com/compose/django/)
* [Best practices for writing Dockerfiles](https://docs.docker.com/engine/userguide/eng-image/dockerfile_best-practices/)

docker-django-boilerplate

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README