A Django project behind the Clear My Record website
Clone or download
Pull request Compare This branch is 1 commit ahead, 165 commits behind codeforamerica:develop.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
favicons
features
formation
health_check
heroku_hijack_collectstatic
intake
partnerships
pdfs
phone
printing
project
requirements
templates
tests
user_accounts
.codeclimate.yml
.coveragerc
.gitignore
.pep8
.ruby-version
.travis.yml
Gemfile
Gemfile.lock
Makefile
Procfile
README.md
app.json
local_settings.py.example
manage.py
package.json
requirements.txt
runtime.txt

README.md

Intake

Join the chat at https://gitter.im/codeforamerica/intake

Build Status Test Coverage Code Climate Requirements Status

Requirements

To get a local version of intake running, you'll need to have the following installed:

Installation and Setup

Quickstart

An overview of the command line steps to get started

git clone https://github.com/codeforamerica/intake.git
cd intake
createdb intake
cp ./local_settings.py.example ./local_settings.py
# add database connection info to local_settings.py
python3 -m venv .
source bin/activate
make install
./manage.py collectstatic
make db.setup  # migrate the database and add seed data
make serve   # run the server

Installation

Be sure to install all the dependencies in a python virtual environment. make install will install both npm packages as well as python packages.

git clone https://github.com/codeforamerica/intake.git
cd intake
python3 -m venv .  # or virtualenv .
source bin/activate
make install

Copy the local settings

cp ./local_settings.py.example ./local_settings.py

Set up the database

Make sure you have a local PostgreSQL database, and that you know the login information. Add this database information to local_settings.py. If you're not sure how to setup a PostgreSQL database, [read more documentation](Local PostreSQL) before proceeding.

For example, if I have a default user named postgres:

# create a database named "intake"
createdb intake
# in local_settings.py
DATABASES = {
    'default': {
        'ENGINE': 'django.db.backends.postgresql_psycopg2',
        'NAME': 'intake',
        'USER': 'postgres',
    }
}

With the database connection information in place, the following command will migrate the database and add seed data:

make db.setup

Build static assets

This only needs to be run the first time you set up.

./manage.py collectstatic

Run the local server

The following command will spin up a local server at http://localhost:8000/

make serve

Testing

To run the test suite, use:

make test

If you'd like to see coverage results you can use:

make test.coverage

Some of the tests take longer to run than others. Some of them need to create and read pdfs on the file system. These do not run local by default. But they do run during Travis builds. If you'd like to include these slower tests you can run them with:

make test.deluxe

To target a particular test, you can add a SCOPE variable. For example if I want to just test that an org user can only see applications to their own organization on the app index page, I would run:

make test \
    SCOPE=intake.tests.views.test_admin_views.TestApplicationIndex.test_that_org_user_can_only_see_apps_to_own_org

Alternatively you could run all the tests for the admin views with:

make test \
    SCOPE=intake.tests.views.test_admin_views

As you can see, the SCOPE variable should use the syntax of a python import path.

Debugging and introspection

The requirements include a few libraries that are helpful for debugging and exploring functionality.

ipdb breakpoints

To set an interactive breakpoint somewhere in the code, insert this line:

import ipdb; ipdb.set_trace()

Here is a Sublime Text snippet that lets you type ipd as shortcut for the line above. Go to Tools > Developer > New Snippet while a python file is open.

The execution will enter an interactive prompt at this point in the code, with tab completion and a variety of shortcuts available.

  • s or step: step into the next execution frame.
  • c or continue: Continue exection
  • u or up: Move up one frame in the stack trace.
  • d or down: Move down one frame in the stack trace.
  • n or next: continue to the next line.
  • ll: show the lines of code in the current function.
  • pp: pretty print an object. For example, (pp my_object).

shell_plus interactive python shell

To load an interactive ipython prompt with tab completion, models, and other useful things preloaded, run this shell command:

./manage.py shell_plus

Any print commands will pretty print by default. Tab completion is available.

Static Asset Handling

Static assets are managed in each applications static folder for example in intake/static/intake

Less and Javascript files are compiled using compressor but we have combined that with collectstatic

./manage.py collectstatic -c --no-input

When doing local development COMPRESS_OFFLINE should be set to False and the assets with automatically build at load time.