Skip to content

Latest commit

 

History

History
76 lines (56 loc) · 2.06 KB

README.rst

File metadata and controls

76 lines (56 loc) · 2.06 KB
Raw

django-project-template

This project provides an alternative startproject structure with some boilerplate code for a quick start of your Django Projects.

Installation

$ django-admin.py startproject --extension=txt,json --name=Makefile,Procfile,.env-example --template=https://github.com/dvl/django-project-template/archive/master.zip my_project
$ cd my_project
$ npm install
$ cp .env-example .env
$ vim .env (to edit your database settings)
$ pip install -r requirements.txt
$ python manage.py migrate

Usage

To start development server

$ make serve

To run tests and get code coverage

$ make test

Featuring

  • Django 1.8
  • django-debug-toolbar and django-extensions because every project should have it.
  • django-flat-theme that probably will be included in a future Django's release, so you can get familiar with it.
  • A settings.py compatible with 12factor powered by python-decouple and dj-database-url.
  • Custom home page.
  • Custom login and password change page based on contrib.auth (so maybe people will stop doing it from scratch).
  • bower and django-compressor for assets management.
  • django-crispy-forms for easy form display.
  • Procfile, whitenoise, waitress-server and psycopg2 for easy deployment on Heroku.
  • Makefile to run tests and get coverage report.
  • bcrypt instead of pbkdf2 (see notes bellow).

Notes

This project is configured to use bcrypt instead of Django's default pbkdf2 because it's better but you may need an additional package to make it works, to install use:

$ sudo apt-get install libssl-dev libffi-dev python-dev

You can also remove PASSWORD_HASHERS from settings.py and bcrypt==1.1.1 from requirements.txt to make Django use the default pbkdf2 and no additional extra package will be required.