{% if False %}

(See our requires.io documentation).

Installation

To start a new project with this template:

django-admin.py startproject \
  --template=https://github.com/caktus/django-project-template/zipball/master \
  --extension=py,rst,yml,sh,js \
  --name=Makefile,gulpfile.js,package.json,Procfile \
  <project_name>

License

Copyright (c) 2017, Caktus Consulting Group, LLC

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

{% endif %}

{{ project_name|title }}

Below you will find basic setup and deployment instructions for the {{ project_name }} project. To begin you should have the following applications installed on your local development system:

• Python >= 3.7
• NodeJS >= 10.16
• pip >= 19
• virtualenv >= 1.10
• virtualenvwrapper >= 3.0
• Postgres >= 9.3
• git >= 1.7

Installing the proper NodeJS versions for each of your projects can be difficult. It's probably best to use nvm.

Django version

The Django version configured in this template is conservative. If you want to use a newer version, edit requirements/base.txt.

Getting Started

First clone the repository from Github and switch to the new directory:

$ git clone git@github.com:[ORGANIZATION]/{{ project_name }}.git
$ cd {{ project_name }}

To setup your local environment you can use the quickstart make target setup, which will install both Python and Javascript dependencies (via pip and npm) into a virtualenv named "{{ project_name }}", configure a local django settings file, and create a database via Postgres named "{{ project_name }}" with all migrations run:

$ make setup
$ workon {{ project_name }}

If you require a non-standard setup, you can walk through the manual setup steps below making adjustments as necessary to your needs.

To setup your local environment you should create a virtualenv and install the necessary requirements:

# Check that you have python3.7 installed
$ which python3.7
$ mkvirtualenv {{ project_name }} -p `which python3.7`
({{ project_name }})$ pip install -r requirements/dev.txt
({{ project_name }})$ npm install

Next, we'll set up our local environment variables. We use django-dotenv to help with this. It reads environment variables located in a file name .env in the top level directory of the project. The only variable we need to start is DJANGO_SETTINGS_MODULE:

({{ project_name }})$ cp {{ project_name }}/settings/local.example.py {{ project_name }}/settings/local.py
({{ project_name }})$ echo "DJANGO_SETTINGS_MODULE={{ project_name }}.settings.local" > .env

Create the Postgres database and run the initial migrate:

({{ project_name }})$ createdb -E UTF-8 {{ project_name }}
({{ project_name }})$ python manage.py migrate

If you want to use Travis to test your project, rename project.travis.yml to .travis.yml, overwriting the .travis.yml that currently exists. (That one is for testing the template itself.):

({{ project_name }})$ mv project.travis.yml .travis.yml

Development

You should be able to run the development server via the configured dev script:

({{ project_name }})$ npm run dev

Or, on a custom port and address:

({{ project_name }})$ npm run dev -- --address=0.0.0.0 --port=8020

Any changes made to Python, Javascript or Less files will be detected and rebuilt transparently as long as the development server is running.

Deployment

There are different ways to deploy, and this document outlines a few of them that could be used for {{ project_name }}.

Deployment with fabric

We use a library called fabric as a wrapper around a lot of our deployment functionality. However, deployment is no longer fully set up in this template, and instead you'll need to do something like set up Tequila for your project. Currently, best way to do that is to copy the configuration from an existing project. Once that is done, and the servers have been provisioned, you can deploy changes to a particular environment with the deploy command:

$ fab staging deploy

Deployment with Dokku

Alternatively, you can deploy the project using Dokku. See the Caktus developer docs.