# Title of Application

Fill me in with a quick, high-level introduction to what this application does.  

## Slack Channels
#example-slack-channel

## Maintainers
Example Squad One, Example Squad Two

## Installation

Fill me in with installation instructions.
```
$ FILL ME IN
$ WITH SPECIFIC COMMANDS
```
---

## Configuration

Fill me in with env vars and configuration notes

```sh
$ FILL ME IN WITH COMMANDS LIKE
$ cp .env.shadow .env
```
---

## Permissions

Fill me in with anything to note about necessary permissions to run this application.

---

## Running

#### Locally
Fill me in with specific instructions on how to run this application locally.

```bash
(env) $ FILL ME IN
```

or

```bash
make FILL ME IN
```
#### Updating

To install new dependencies:

```bash
(env) $ FILL IN WITH COMMANDS LIKE
(env) $ pip install -r requirements.txt
(env) $ pip install -r requirements-dev.txt
```

or

```bash
FILL ME IN
```

#### Production
Fill me in with instructions to run in production.

---

## Testing

Fill me in with commands to run tests, e.g.:

```bash
(env) $ FILL ME IN WITH COMMANDS LIKE
(env) $ py.test tests/unit/
(env) $ py.test tests/integration/
(env) $ flake8 example/ tests/
```

or

To run unit tests: `FILL ME IN`

To run unit tests with coverage reporting: `FILL ME IN`

To run integration tests: `FILL ME IN`

To lint: `FILL ME IN`

---

## Debugging Links
Fill in with DataDog, Sentry, Jenkins jobs or related links for debugging

---

## Notes
Fill me in with other, uncategorized things to note.