https://github.com/fasouto/django-starter-template

A project template for Django 2.0 that follows best practices.
https://github.com/fasouto/django-starter-template

django project-creation project-template

Last synced: 24 days ago
JSON representation

A project template for Django 2.0 that follows best practices.

• Host: GitHub
• URL: https://github.com/fasouto/django-starter-template
• Owner: fasouto
• License: mit
• Created: 2014-07-20T16:52:39.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2022-12-08T06:34:12.000Z (about 2 years ago)
• Last Synced: 2024-04-15T14:22:19.499Z (9 months ago)
• Topics: django, project-creation, project-template
• Language: Python
• Homepage:
• Size: 752 KB
• Stars: 150
• Watchers: 15
• Forks: 43
• Open Issues: 9
• Metadata Files:
  • Readme: readme.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-projects-boilerplates - Django Starter Template

README

        
# django-starter-template #

An easy to use project template for Django 2.0 that follows best practices.

## Features ##

- [Django compressor](http://django-compressor.readthedocs.org/en/latest/) to compress JS and CSS and compile LESS/SASS files.

- [Pipenv](https://docs.pipenv.org) To manage dependences and virtualenvs.

- [Django debug toolbar](http://django-debug-toolbar.readthedocs.org/) enabled for superusers.

- [Argon2](https://docs.djangoproject.com/en/2.0/topics/auth/passwords/#using-argon2-with-django) to hash the passwords

## Quickstart ##

Make sure you have [pipenv installed](https://docs.pipenv.org/install.html). Then install Django 2.0 in your virtualenv:

    pip install django==2.0

To create a new Django project (make sure to change `project_name`)

    django-admin.py startproject --template=https://github.com/fasouto/django-starter-template/archive/master.zip --extension=py,md,html,txt project_name

cd to your project and install the development dependences

    pipenv install --dev

If you need a database, edit the settings and create one with

   

    pipenv run python manage.py migrate

Once everything it's setup you can run the development server: [http://localhost:8000/](http://localhost:8000/)

    pipenv run python manage.py runserver

## How to use it ##

### Settings ###

Settings are divided by environments: production.py, development.py and testing.py. By default it uses development.py, if you want to change the environment set a environment variable:

    export DJANGO_SETTINGS_MODULE="my_project.settings.production"

or you can use the `settings` param with runserver:

    pipenv run python manage.py runserver --settings=my_project.settings.production

If you need to add some settings that are specific for your machine, rename the file `local_example.py` to `local_settings.py`. This file it's in .gitignore so the changes won't be tracked.

### TODO ###

 - Add webpack with live SASS reloading.

 - Add gitlab.ci

 - Improve tox.ini

 - Add deployment options.

 - Add some example code and tests.