This is a Rails 7 app.
This README describes the purpose of this repository and how to set up a development environment.
This project requires:
- Ruby 3.0.4, preferably managed using rbenv
- PostgreSQL must be installed and accepting connections
On a Mac, you can obtain all of the above packages using Homebrew.
If you need help setting up a Ruby development environment, check out this Rails OS X Setup Guide.
Run the bin/setup
script. This script will:
- Check you have the required Ruby version
- Install dependencies using Bundler and Yarn
- Create a
.env.development
file - Create, migrate, and seed the database
- Run
bin/rake
to run all tests and lint checks. - Start the app with
yarn start
Access the app at http://localhost:3000/.
Ensure the following environment variables are set in the deployment environment:
DATABASE_URL
RACK_ENV
RAILS_ENV
REDIS_URL
SECRET_KEY_BASE
Optionally:
BASIC_AUTH_PASSWORD
BASIC_AUTH_USERNAME
POSTMARK_API_KEY
RAILS_FORCE_SSL
RAILS_HOSTNAME
RAILS_LOG_TO_STDOUT
RAILS_MAX_THREADS
RAILS_SERVE_STATIC_FILES
SIDEKIQ_CONCURRENCY
SIDEKIQ_WEB_PASSWORD
SIDEKIQ_WEB_USERNAME
WEB_CONCURRENCY