Skip to content

Latest commit

 

History

History
236 lines (143 loc) · 6.22 KB

README.md

File metadata and controls

236 lines (143 loc) · 6.22 KB
Raw

City Hall Monitor

Development quickstart

Create the database, run migrations, and load fixtures

$ cp env.example .env
$ docker-compose build
$ docker-compose up pg
$ ./initdb.sh

Optionally, load the extra production data (a rather large data dump) WARNING: The current data file appears to be out of data and does not contain all of the needed data fields. Currently, this will break things.

$ ./importdata.sh

$ docker-compose down

Run the development server

The default compose file will:

  • start a postgres container
  • start an application container and run the Django dev server in debug mode.

The application is served internally on port 8000 which is mapped to 80 on the localhost.

$ docker-compose up

Go to: http://localhost.

Alternative localized "deployment"

This configuration looks more like deployment, but is slightly more awkward for development, particularly for making changes to static files:

docker-compose.local.yml will:

  • start a postgres container
  • start an Nginx container
  • start an application container and run the application via gunicorn

The application is served internally on socket file which is proxied to port 80 on the localhost.

If running the local deployment on https, you will need to create ssl certs. Be sure to have minica installed, then:

$ cd nginx
$ minica --domains localhost

This will create the following gitignored files that will be copied into the nginx build (see the nginx Dockerfile for details):

  • nginx/localhost/cert.pem
  • nginx/localhost/key.pem
  • minica.pem
$ docker-compose -f docker-compose.local.yml build
$ docker-compose -f docker-compose.local.yml up

Go to: http://localhost or https://localhost

Note: Content below here has not yet been reviewed since containerizing the application.

DEV NOTES

Use pull_data to pull basic data into the system:

python manage.py pull_data <MODEL>

Run with --help option to see what models are supported, e.g.

python manage.py pull_data --help

Due to the use of ForeignKeys, some data has to be pulled before other data (e.g. BodyType data has to be pulled before Body data, because the latter references the former). The following order seems to work well:

  1. Person
  2. BodyType
  3. Body
  4. MatterType
  5. MatterStatus
  6. Matter

pull_sponsors will download the MatterSponsor records.

pull_attachments will download the MatterAttachment records, but not the actual PDF files.

pull_pdfs will upload the PDF files to DocumentCloud. For development, you will likely only want to pull a portion of the files as it can take several hours to harvest all of them (around 58,000 total).

pull_text will download the extracted text from the files in DocumentCloud to the database. For development, you will likely only want to pull the text for a portion of the files as it can take several hours to harvest all of them.

Local development setup

Install Python 3.4.4

Download installer from https://www.python.org/downloads/release/python-343/

OR

Install using Homebrew:

brew install python3

Note: Whichver of the above you chose, you may need to upgrade virtualenvwrapper.

sudo pip install virtualenvwrapper --upgrade

Install PostgreSQL

Download and run installer for Mac OS X Version 9.3.9

http://www.enterprisedb.com/products-services-training/pgdownload

Default installation directory = /Library/PostgreSQL/9.3
Default data directory /Library/PostgreSQL/9.3/data
Default Port = 5432
Use default locale

Add the PostgreSQL bin directory to your PATH environment variable:

PATH=$PATH:/Library/PostgreSQL/9.3/bin

You may need to add the PostgreSQL lib directory to your DYLD_FALLBACK_LIBRARY_PATH environment variable:

DYLD_FALLBACK_LIBRARY_PATH=$DYLD_FALLBACK_LIBRARY_PATH:/Library/PostgreSQL/9.3/lib

or

Install using Homebrew:

brew install postgres --with-python

(I installed Postgres with homebrew a long time ago, so can't verify this exact command.)

Setup PostgreSQL

Create the cityhallmonitor database and cityhallmonitor user by executing the initdb.sh script.

$ ./initdb.sh

This script assumes you've created a Postgres admin user with the same username as your shell login. If that's not the case, use this form instead:

$ PGUSER="postgres" ./initdb.sh

If your Postgres admin user has a different name, change the value of PGUSER.

This script doesn't always work. You can do it manually:

$ createdb -U postgres cityhallmonitor
$ psql -U postgres cityhallmonitor
cityhallmonitor=# CREATE USER cityhallmonitor WITH PASSWORD 'default';
cityhallmonitor=# GRANT ALL PRIVILEGES ON DATABASE "cityhallmonitor" to cityhallmonitor;
cityhallmonitor=# \q

Verify you can connect to database as cityhallmonitor user:

$ psql -U cityhallmonitor cityhallmonitor

Setup project

Make virtual environment and install requirements:

$ mkvirtualenv --python=/usr/local/bin/python3 cityhallmonitor
$ pip install -r requirements.txt

Create database tables:

python manage.py syncdb

Load sample data fixtures (for now):

$ python manage.py loaddata MatterType.json

Installing SASS

To work with the project's CSS, you must use SASS. (Don't write your styles directly in cityhallmonitor.css or your changes will be overwritten when the SASS compiler runs next!)

Install SASS if you need it: http://sass-lang.com/install

From your root cityhallmonitor project directory, run sass --watch static/sass:static/css

Make your changes in cityhallmonitor.scss and the compiler will update your CSS file when you save.

Deployment

Use the git-deploy subcommand script to deploy to stg and prd. Be sure git-deploy is on your PATH and you are setup to ssh into the appropriate servers.

You will need the folling include in your local .git/config for this repository:

[include]
    path = ../conf/deploy.conf

This adds endpoints and configurations to enable the git-deploy commands

Example:

git deploy stg --migrate merges master into stg and deploys code to the stg application and work servers, executes database migrations, and restarts the cityhallmonitor application service.