From 75dafe66dacd6c659100eb3d02facdc5512e375c Mon Sep 17 00:00:00 2001 From: Vaidehi Joshi Date: Wed, 22 Jan 2020 14:37:08 -0800 Subject: [PATCH] Add note to help debug `bin/setup` issues. (#5651) When starting the app for the first time, it's possible to run into some issues while trying to run `bin/setup`. For example, when I started the app, I got an (unhelpful) error when running `bin/setup` and ended up figuring out the issue (needing to `yarn install`) by running the contents of the Procfile.dev file directly. We should help point folks to this file so that they can run a command that gives them a more helpful error message, which should hopefully let them get the app up and running with any problems! :) --- docs/getting-started/start-app.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/getting-started/start-app.md b/docs/getting-started/start-app.md index 5e0b4f021..933cf2230 100644 --- a/docs/getting-started/start-app.md +++ b/docs/getting-started/start-app.md @@ -18,6 +18,10 @@ bin/startup Then point your browser to http://localhost:3000/ to view the site. +If you run into issues while trying to run `bin/setup` and the error message +isn't helpful, try running `bin/rails s -p 3000`. For example, you may need to +`yarn install` before starting the app. + If you're working on DEV regularly, you can use `alias start="bin/startup"` to make this even easier. 😊