https://github.com/mbta/arrow

Adjustments to the Regular Right of Way
https://github.com/mbta/arrow

Last synced: about 1 month ago
JSON representation

Adjustments to the Regular Right of Way

• Host: GitHub
• URL: https://github.com/mbta/arrow
• Owner: mbta
• License: mit
• Created: 2019-11-15T14:31:54.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2024-11-22T19:56:43.000Z (about 1 month ago)
• Last Synced: 2024-11-22T20:33:09.430Z (about 1 month ago)
• Language: Elixir
• Size: 3.61 MB
• Stars: 2
• Watchers: 19
• Forks: 1
• Open Issues: 19
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# Arrow

🏹 Adjustments to the Regular Right of Way

## Setup

### Requirements

- [`asdf`](https://github.com/asdf-vm/asdf)

  - Add `erlang`, `elixir`, and `nodejs` plugins

  - Install [additional requirements][nodejs-reqs] for `nodejs` plugin

- [`direnv`](https://github.com/direnv/direnv)

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

[nodejs-reqs]: https://github.com/asdf-vm/asdf-nodejs#requirements

### Instructions

- `asdf install`

- `mix deps.get`

- `mix esbuild.install`

- `npm install --prefix assets`

- `direnv allow`

- `cp .envrc.example .envrc`

- Update `.envrc` with your local Postgres username and password

- Update `.envrc` with your AWS credentials or ensure they are available in your shell

- Update `.envrc` with the Arrow Dev Keycloak client secret (found in 1Password)

- `mix ecto.setup`

- `brew install chromedriver`

- Add your Arrow API key from https://arrow.mbta.com/mytoken to `.envrc`

- `mix copy_db` to seed your database

### Useful commands

- Run the app: `mix phx.server` (visit )

- Elixir:

  - `mix test` — run tests

  - `mix test.integration` — run integration tests

  - `mix dialyzer` — check typespecs

  - `mix format` — format code

  - `mix credo` — lint code

- JavaScript: `cd assets` and...

  - `npm run test` — run tests

  - `npm run test -- --watch` — run tests continuously for changed code

  - `npm run format` — format code

  - `npm run lint` — lint code (and fix automatically if possible)