emileighoutlaw/ekip-api

EKIP API

EKIP API

ticketing-system

A ticketing system.

Getting Started

Make sure you have vagrant installed. For instance, on OS X with Homebrew:

$ brew install caskroom/cask/brew-cask
$ brew cask install vagrant

Then, ensure you have the appropriate Vagrant Box installed:

$ vagrant box add ubuntu/trusty32

You can get started with development by running the Vagrantfile:

$ vagrant up

This will provision an entire setup for you pretty quickly (see provision/dev/bootstrap.sh). You can access Django and start runserver by doing the following:

$ vagrant ssh
$ python manage.py runserver

From your host computer, going to http://192.168.19.16 will enable you to access the API.

Front-end Setup

This project uses Gulp to manage CSS pre and post-processing. Make sure Gulp is installed system wide:

npm install --global gulp

Also install the additional modules to watch for SASS pre-processing changes (using Bourbon and Neat) and to minify the resulting stylesheet:

npm install gulp-watch gulp-sass node-neat node-bourbon gulp-minify-css gulp-rename

Then once everything is installed in your project directory, simply invoke the Gulp command in your terminal:

gulp

Testing

To run tests locally:

python manage.py test --settings=config.settings.test

Deploy Notes

We use a blue-green deployment system for zero downtime.

Setting up the applications.

======= You'll need to set the application to use the production settings file.

cf set-env blue DJANGO_SETTINGS_MODULE config.settings.production
cf set-env green DJANGO_SETTINGS_MODULE config.settings.production

You'll need to set three environment variables, for both blue and green apps to use S3 for hosting static files. Do this once.

cf set-env blue EKIP_STATIC_BUCKET_NAME <<S3 static files bucket name>>
cf set-env blue EKIP_AWS_ACCESS_KEY_ID <<value>>
cf set-env blue EKIP_AWS_SECRET_ACCESS_KEY <<value>>
cf set-env green EKIP_STATIC_BUCKET_NAME <<S3 static files bucket name>>
cf set-env green EKIP_AWS_ACCESS_KEY_ID <<value>>
cf set-env green EKIP_AWS_SECRET_ACCESS_KEY <<value>>

Running deploys

To actually deploy the application, simply configure for your use case and run:

./deployer.sh

Running database migrations

Use cf-ssh to create an instance of the application you can ssh into, and then run:

python manage.py migrate --settings=config.settings.production