![POLITICO](https://rawgithub.com/The-Politico/src/master/images/logo/badge.png)

# <%= name %>

### Quickstart

1. Install the app.

  ```
  $ pip install <%= name %>
  ```

2. Add the app to your Django project and configure settings.

  ```python
  INSTALLED_APPS = [
      # ...
      'rest_framework',
      '<%= app %>',
  ]

  #########################
  # <%= app %> settings

  <%= allcaps %>_SECRET_KEY = ''
  <%= allcaps %>_AWS_ACCESS_KEY_ID = ''
  <%= allcaps %>_AWS_SECRET_ACCESS_KEY = ''
  <%= allcaps %>_AWS_REGION = ''
  <%= allcaps %>_AWS_S3_BUCKET = ''
  <%= allcaps %>_CLOUDFRONT_ALTERNATE_DOMAIN = ''
  <%= allcaps %>_S3_UPLOAD_ROOT = ''
  ```

### Developing

##### Running a development server

Developing python files? Move into example directory and run the development server with pipenv.

  ```
  $ cd example
  $ pipenv run python manage.py runserver
  ```

Developing static assets? Move into the pluggable app's staticapp directory and start the node development server, which will automatically proxy Django's development server.

  ```
  $ cd <%= app %>/staticapp
  $ gulp
  ```

Want to not worry about it? Use the shortcut make command.

  ```
  $ make dev
  ```

##### Setting up a PostgreSQL database

1. Run the make command to setup a fresh database.

  ```
  $ make database
  ```

2. Add a connection URL to the `.env` file.

  ```
  DATABASE_URL="postgres://localhost:5432/<%= app %>"
  ```

3. Run migrations from the example app.

  ```
  $ cd example
  $ pipenv run python manage.py migrate
  ```