Screenplay

Enables OIOs to view and manage screens that provide transit info to riders.

Prerequisites

Postgres

If you don't already have Postgres installed, and you're on a Mac, Postgres.app is an easy way to get started. However, any Postgres instance to which you can connect and in which you have sufficient privileges should work.

Screens

Screenplay requires the Screens config to be available at ../screens/priv/local.json. To generate this file, follow these steps:

1. cd ..
2. git clone [email protected]:mbta/screens.git
3. cd screens
4. Follow the Getting Started docs to generate the files needed by Screenplay.

Realtime-Signs

This repo expects Realtime Signs to be cloned and for ../realtime_signs/priv/signs.json to be available. This can be done by doing the following:

1. cd ..
2. git clone [email protected]:mbta/realtime_signs.git

Local Development Setup

Install tools

1. Install asdf
2. Install language build dependencies: brew install coreutils
3. asdf plugin-add ... for each tool listed in .tool-versions
4. asdf install

Set up environment

1. Install direnv
2. cp .envrc.template .envrc
3. Fill in API_V3_KEY with a V3 API key
4. Fill in DATABASE_USER and DATABASE_PASSWORD with the username and password of a DB user configured in your local psql server
5. direnv allow

Note the various _URL values in .envrc, which default to the production environments of the relevant apps — change these to e.g. point Screenplay to your own local instances.

Copy configuration

1. Install the aws CLI and configure with your AWS credentials
   • To verify everything works, try: aws s3 ls mbta-ctd-config
2. Run scripts/pull_configs.sh prod

To copy config files from a different Screenplay environment, replace prod in the command above.

Start the server

1. mix deps.get
2. mix ecto.create to stand up DB used by PA Messaging features
3. npm install --prefix assets
4. mix phx.server
5. Visit http://localhost:4444

Optional: AWS credentials

In deployed environments, the app uses S3 for its configuration. If you ever want to replicate this behavior locally, you'll need to provide the environment variables AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY. For security reasons these should only be stored in 1Password and not directly in your .envrc.