Skip to content

Commit 7825688

Browse files
justin808claude
andauthored
Add foreman/overmind requirement to Getting Started guides (#1897)
New developers following the Getting Started guides encounter the "can't find executable foreman" error when running ./bin/dev. This commit adds clear documentation about this prerequisite in both the Quick Start and Using React on Rails guides. Changes: - Add foreman/overmind to Prerequisites section in quick-start.md - Add installation instructions before bin/dev command in quick-start.md - Add note with installation info in using-react-on-rails.md - Include links to detailed installation guides for both tools - Emphasize global installation requirement for foreman This improves the developer onboarding experience by surfacing this requirement before developers encounter errors. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-authored-by: Claude <[email protected]>
1 parent a59bbb7 commit 7825688

File tree

2 files changed

+8
-0
lines changed

2 files changed

+8
-0
lines changed

docs/getting-started/quick-start.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ Before starting, make sure you have:
1313
- **Rails 7+** application (Rails 5.2+ supported)
1414
- **Ruby 3.0+** (required)
1515
- **Node.js 20+** and **Yarn**
16+
- **Foreman or Overmind** (for running `bin/dev`)
1617
- **Basic familiarity** with React and Rails
1718

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

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

46+
> **Note:** Ensure you have `overmind` or `foreman` installed to run `bin/dev`.
47+
>
48+
> - **overmind**: `brew install overmind` (macOS) or see [installation guide](https://github.com/DarthSim/overmind#installation)
49+
> - **foreman**: `gem install foreman` (install globally, not in your project bundle - [details](https://github.com/ddollar/foreman/wiki/Don't-Bundle-Foreman))
50+
4551
Start both Rails and the Webpack dev server:
4652

4753
```bash

docs/getting-started/using-react-on-rails.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -149,6 +149,8 @@ The generator creates `bin/dev` for starting both:
149149
- Rails server (port 3000)
150150
- Webpack dev server (for hot reloading)
151151

152+
> **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.
153+
152154
---
153155

154156
## Render-Functions and RailsContext

0 commit comments

Comments
 (0)