Below you will find basic setup and deployment instructions for the AQIService 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.
The Django version configured in this template is conservative. If you want to
use a newer version, edit requirements/base.txt.
First clone the repository from Github and switch to the new directory:
$ git clone git@github.com:[ORGANIZATION]/AQIService.git $ cd AQIService
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 "AQIService", configure a local django settings file, and create a database via Postgres named "AQIService" with all migrations run:
$ make setup $ workon AQIService
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 AQIService -p `which python3.7` (AQIService)$ pip install -r requirements/dev.txt (AQIService)$ 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:
(AQIService)$ cp AQIService/settings/local.example.py AQIService/settings/local.py (AQIService)$ echo "DJANGO_SETTINGS_MODULE=AQIService.settings.local" > .env
Create the Postgres database and run the initial migrate:
(AQIService)$ createdb -E UTF-8 AQIService (AQIService)$ 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.):
(AQIService)$ mv project.travis.yml .travis.yml
You should be able to run the development server via the configured dev script:
(AQIService)$ npm run dev
Or, on a custom port and address:
(AQIService)$ 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.
There are different ways to deploy, and this document outlines a few of them that could be used for AQIService.
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
Alternatively, you can deploy the project using Dokku. See the Caktus developer docs.