Skip to content

Add foreman/overmind requirement note to Getting Started guide #1870

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Add foreman/overmind requirement note to Getting Started guide #1870

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3f8ce8c
Add foreman/overmind requirement note to Getting Started guide
justin808 Oct 21, 2025
0f67526
Add installation instructions and improve note placement
justin808 Oct 23, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion docs/getting-started.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,12 +66,17 @@ cd PROJECT_NAME
bundle exec rails generate react_on_rails:install
```

> **Note:** Ensure that you have `overmind` or `foreman` installed to run `bin/dev`.
>
> - **overmind**: `brew install overmind` (macOS) or see [installation guide](https://github.com/DarthSim/overmind#installation)
> - **foreman**: `gem install foreman` (install globally, not in your project bundle - [details](https://github.com/ddollar/foreman/wiki/Don't-Bundle-Foreman))

Start the app:

```bash
bin/dev help
bin/dev # start with hmr
bin/dev static #
bin/dev static # start with statically created bundles (no HMR)
```

## Basic Usage
Expand Down
Loading