soya-miyoshi / rails-example

My rails example project. TODO: add CI, improve developer experience

rails_example

This is a Rails 7 app.

Documentation

This README describes the purpose of this repository and how to set up a development environment.

Prerequisites

This project requires:

• Ruby 3.1.1, preferably managed using rbenv
• Bundler 2.4.21 (run bundle update --bundler)
• gem 3.4.21
• Node and Yarn 1.x (npm install -g yarn)
• PostgreSQL must be installed and accepting connections (run brew install postgresql )

On a Mac, you can obtain all of the above packages using Homebrew.

Getting started

bin/setup

Run the bin/setup script. This script will:

• Install dependencies using Bundler and Yarn
• Create a .env.development file
• Create, migrate, and seed the database

Run it!

Start the app with yarn start.

The app will be located at http://localhost:3000/.

Development

To run the full suite of tests and lint checks, run:

$ bin/rake

To auto-correct formatting and linting issues, run:

$ bin/rake fix

Deployment

Ensure the following environment variables are set in the deployment environment:

• DATABASE_URL
• RACK_ENV
• RAILS_ENV
• SECRET_KEY_BASE

Optionally:

• BASIC_AUTH_PASSWORD
• BASIC_AUTH_USERNAME
• POSTMARK_API_KEY
• RAILS_DISABLE_SSL
• RAILS_HOSTNAME
• RAILS_LOG_TO_STDOUT
• RAILS_MAX_THREADS
• RAILS_SERVE_STATIC_FILES
• REDIS_URL
• SIDEKIQ_CONCURRENCY
• SIDEKIQ_WEB_PASSWORD
• SIDEKIQ_WEB_USERNAME
• WEB_CONCURRENCY