https://github.com/mbta/orbit

https://github.com/mbta/orbit

Last synced: about 1 month ago
JSON representation

• Host: GitHub
• URL: https://github.com/mbta/orbit
• Owner: mbta
• License: mit
• Created: 2024-02-23T16:23:22.000Z (11 months ago)
• Default Branch: main
• Last Pushed: 2024-10-29T17:11:38.000Z (2 months ago)
• Last Synced: 2024-10-29T18:39:27.193Z (2 months ago)
• Language: Elixir
• Size: 742 KB
• Stars: 1
• Watchers: 9
• Forks: 0
• Open Issues: 8
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

        
# Orbit 🪐

[Glides](https://github.com/mbta/glides) for Heavy Rail

## Pre-reqs

- Homebrew ([installation directions](https://brew.sh/))

- Postgres: `brew install postgresql`

  - Brew may ask you to upgrade your database upon installation: `brew postgresql-upgrade-database`

  - Start Postgres with `brew services start postgresql`

  - If this is the first time you've used it, you may need to create a database. Run `createdb`

- `mise` or `asdf`:

  - `mise`:

    - `curl https://mise.run | sh` or `brew install mise`

    - `mise install`

  - `asdf`:

    - `brew install asdf`

    - You may need to run `asdf plugin add` some of `erlang`, `elixir`, or `nodejs`.

    - `asdf install`

## Set up

- `bin/setup` (rerun after any dependencies are updated)

Run the server with `mix phx.server`.

Now you can visit [`localhost:4001`](http://localhost:4001) from your browser.

## Tests

Run `bin/test` to run all backend and frontend test suites.

Run `mix test test/path/to/file_test.exs` or `npm run test:jest -- js/path/to/file.test.ts` to run a specific unit test.

See [`bin/test`](bin/test), [`mix.exs`](mix.exs), and [`package.json`](package.json) for other test commands.

To see code coverage, run `mix test --cover` or `npm run test:jest -- --coverage`. These generate `lcov.info` files which can be viewed with tools like the VSCode extension "Coverage Gutters".

## Docker

To run the Docker container locally, run `docker compose up --build`.

Find what port the server is using with `docker compose ps`,

and then visit `localhost:`.