https://github.com/mbta/alerts_concierge

https://github.com/mbta/alerts_concierge

Last synced: about 1 month ago
JSON representation

• Host: GitHub
• URL: https://github.com/mbta/alerts_concierge
• Owner: mbta
• License: mit
• Created: 2017-03-29T17:28:46.000Z (almost 8 years ago)
• Default Branch: main
• Last Pushed: 2024-09-16T13:12:54.000Z (4 months ago)
• Last Synced: 2024-09-16T15:27:11.561Z (4 months ago)
• Language: Elixir
• Homepage:
• Size: 8.98 MB
• Stars: 1
• Watchers: 14
• Forks: 1
• Open Issues: 10
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# Alerts Concierge

a.k.a. **[T-Alerts](https://alerts.mbta.com/)**. Enables MBTA riders to

subscribe to notifications for service disruptions.

## Setup

### Requirements

- MBTA API key (get one [here](https://api-dev.mbtace.com))

  - **Note:** This key must have its version set to `2021-01-09`

  - You may need to request an increased rate limit if you get errors during

    the first app startup; 2000 requests per minute should be enough

- PostgreSQL 13 (using Homebrew: `brew install postgresql@13`)

  - You will need Postgres client tools in your PATH; if using Homebrew and you

    get an error about missing tools, use `brew link postgresql@13`

- [Google Chrome](https://www.google.com/chrome/)

- Chromedriver (using Homebrew: `brew install --cask chromedriver`)

- [`asdf`](https://asdf-vm.com/) with plugins: `elixir`, `erlang`, `nodejs`

- [`direnv`](https://direnv.net/) _(optional, for auto-loading env vars)_

### Instructions

1. `asdf install`

2. `mix deps.get`

3. `npm install --prefix apps/concierge_site/assets`

4. `cat .envrc.example | sed -e "s/__username__/$(logname)/g" > .envrc`

5. In `.envrc`: Fill in `API_KEY=` with the API key you obtained above

6. `direnv allow`

7. `mix ecto.setup`

8. `MIX_ENV=test mix ecto.setup`

The above assumes you have a PostgreSQL user with the same name as your OS user

(`logname`), which should be the default with a Homebrew install. Otherwise, you

may need to adjust the username in `.envrc`.

If not using `direnv`, you can instead `source .envrc` to perform a one-time

export of the environment variables into your current shell session.

### Running tests

- `mix test`

### Running the application

- `mix phx.server`

- Visit 

## Deployment

We run the app on AWS: see [`docs/aws.md`](docs/aws.md) for deployment guides.

## Scrubbing the Production Database for Local Usage

See [`scripts/sanitize_db_dump/README.md`](scripts/sanitize_db_dump/README.md)