Skip to content

Add foreman/overmind requirement to Getting Started guides #1897

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

Merged
merged 1 commit into from
Nov 2, 2025
Merged

Add foreman/overmind requirement to Getting Started guides #1897

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 6 additions & 0 deletions docs/getting-started/quick-start.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ Before starting, make sure you have:
- **Rails 7+** application (Rails 5.2+ supported)
- **Ruby 3.0+** (required)
- **Node.js 20+** and **Yarn**
- **Foreman or Overmind** (for running `bin/dev`)
- **Basic familiarity** with React and Rails

> 💡 **Don't have a Rails app?** Run `rails new my_react_app` first.
Expand Down Expand Up @@ -42,6 +43,11 @@ Take a look at the files created by the generator.

## 🎯 Step 2: Start the Development Server (1 minute)

> **Note:** Ensure 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 both Rails and the Webpack dev server:

```bash
Expand Down
2 changes: 2 additions & 0 deletions docs/getting-started/using-react-on-rails.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -149,6 +149,8 @@ The generator creates `bin/dev` for starting both:
- Rails server (port 3000)
- Webpack dev server (for hot reloading)

> **Note:** You need `overmind` or `foreman` installed to run `bin/dev`. Install with `brew install overmind` (macOS) or `gem install foreman` (globally). See the [Quick Start Guide](./quick-start.md#-step-2-start-the-development-server-1-minute) for detailed installation instructions.

---

## Render-Functions and RailsContext
Expand Down
Loading