Django Boilerplate

Build Status Coverage Status

A ready to use django boilerplate project.

Project Django boilerplate
Author Ozcan Yarimdunya
Documentation https://ozcanyarimdunya.github.io/django-boilerplate/
Github https://github.com/ozcanyarimdunya/django-boilerplate/

Features

  • docker support
  • Settings are separated as production and development
  • static, media files and templates set
  • django-constance installed
  • A common app installed with a timestamped BaseModel model

Installation

  1. Clone the repository.

    $ git clone https://github.com/ozcanyarimdunya/django-boilerplate.git myapp
    $ cd myapp/
    
  2. Install the virtualenv package, create new virtual environment and activate it.

    $ pip install virtualenv
    $ virtualenv venv
    $ source venv/bin/activate
    
  3. Install all dependencies and start application on http://127.0.0.1:8000/.

    $ make
    
  4. To access admin panel, create a superuser and visit http://127.0.0.1:8000/admin/.

    $ make superuser
    

Running in docker

  1. Make sure you have installed docker and docker-compose.

    $ make docd
    
  2. To access admin panel, create a superuser in docker and visit http://127.0.0.1:8000/admin/.

    $ docker exec -ti docker_webapp_1 make superuser
    

Documentation

Documentations made by mkdocs. For more info visit here.

    $ make documentation