From 42f8ca88ee9bbdd701c9aac875657c57296cd3ff Mon Sep 17 00:00:00 2001 From: Klaus Zanders Date: Wed, 17 May 2023 15:01:14 +0200 Subject: [PATCH] Add info about bin/dev to docs --- docs/development/development-environment-osx/README.md | 5 +++-- docs/development/development-environment-ubuntu/README.md | 5 +++-- 2 files changed, 6 insertions(+), 4 deletions(-) diff --git a/docs/development/development-environment-osx/README.md b/docs/development/development-environment-osx/README.md index a24178507e4..e359712b85c 100644 --- a/docs/development/development-environment-osx/README.md +++ b/docs/development/development-environment-osx/README.md @@ -191,11 +191,12 @@ RAILS_ENV=development bin/rails db:seed You can run all required workers of OpenProject through `foreman`, which combines them in a single tab. This is useful for starting out, however most developers end up running the tasks in separate shells for better understanding of the log output, since foreman will combine all of them. +The `bin/dev` command will check if `foreman` is available, install it if needed and will run the application via `Procfile.dev` ```bash -gem install foreman -foreman start -f Procfile.dev +bin/dev ``` + The application will be available at `http://127.0.0.1:3000`. To customize bind address and port copy the `.env.example` provided in the root of this project as `.env` and [configure values](https://ddollar.github.io/foreman/#ENVIRONMENT) as required. diff --git a/docs/development/development-environment-ubuntu/README.md b/docs/development/development-environment-ubuntu/README.md index 809e2d6ffd3..50914618dc6 100644 --- a/docs/development/development-environment-ubuntu/README.md +++ b/docs/development/development-environment-ubuntu/README.md @@ -242,11 +242,12 @@ RAILS_ENV=development bin/rails db:seed You can run all required workers of OpenProject through `foreman`, which combines them in a single tab. This is useful for starting out, however most developers end up running the tasks in separate shells for better understanding of the log output, since foreman will combine all of them. +The `bin/dev` command will check if `foreman` is available, install it if needed and will run the application via `Procfile.dev` ```bash -gem install foreman -foreman start -f Procfile.dev +bin/dev ``` + The application will be available at `http://127.0.0.1:3000`. To customize bind address and port copy the `.env.example` provided in the root of this project as `.env` and [configure values](https://ddollar.github.io/foreman/#ENVIRONMENT) as required.