You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
67 lines
1.6 KiB
Plaintext
67 lines
1.6 KiB
Plaintext
# <%= app_name %>
|
|
|
|
This is a Rails <%= Rails::VERSION::MAJOR %> app.
|
|
|
|
## Documentation
|
|
|
|
This README describes the purpose of this repository and how to set up a development environment.
|
|
|
|
## Prerequisites
|
|
|
|
This project requires:
|
|
|
|
* Ruby <%= RUBY_VERSION %>, preferably managed using [rbenv][]
|
|
* PostgreSQL must be installed and accepting connections
|
|
* [Redis][] must be installed and running on localhost with the default port
|
|
|
|
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](https://mattbrictson.com/rails-osx-setup-guide).
|
|
|
|
## Getting started
|
|
|
|
### bin/setup
|
|
|
|
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 it!
|
|
|
|
1. Run `bin/rake` to run all tests and lint checks.
|
|
2. Start the app with `yarn start`
|
|
|
|
Access the app at <http://localhost:3000/>.
|
|
|
|
## Deployment
|
|
|
|
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`
|
|
|
|
[rbenv]:https://github.com/sstephenson/rbenv
|
|
[redis]:http://redis.io
|
|
[Homebrew]:http://brew.sh
|