Skip to content

docs: Update local setup docs #4071

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: main
Choose a base branch
from
+5 −3
Open

docs: Update local setup docs #4071

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b03d732
remove version from docker compose
divagueame Sep 17, 2025
c579572
Update docs to run the dummy app
divagueame Sep 17, 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
6 changes: 5 additions & 1 deletion CONTRIBUTING.MD
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,11 @@ Once you pull the code down to your machine, modify `spec/dummy/config/database.

## Running the dummy app

You can run `bin/dev` from the root directory, which will start an overmind (similar to foreman) process for the rails server, jsbundling and cssbundling. Then, navigate to `localhost:3030` and enjoy the app.
1. Make sure you have [overmind](https://github.com/DarthSim/overmind#installation) or [foreman](https://github.com/ddollar/foreman#installation) installed on your system.
2. Run ```bin/init``` to install ruby and js dependencies, and to setup the database.
Copy link
Contributor

@Paul-Bob Paul-Bob Sep 19, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This step (2) is mentioned just above on the "## Getting your local environment set up" section

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Correct. As a newcomer, I would prefer to have all necessary steps together to get the app running, instead of jumping around and guessing what applies to my case. Maybe would it make sense to update that section instead?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I understand, I didn’t write the CONTRIBUTING.md, but I get the idea of having one section for “Getting your local environment set up” (which you only need to run once during setup), and another section for “Running the dummy app” (which are the exact same steps you run every time you want to start the app after setup).

I see where your confusion comes from, and thanks for looking into this. With the current PR, we have bin/init listed redundantly in both the setup and running sections.

I think there’s value in merging those, but we should clearly mark which steps are “run only once when setting up” and which are “run every time you start the application.”

We just need to refine it a bit so it’s clearer and make sure the steps aren’t redundant or duplicated.

3. If you chose to use Docker Compose for the previous step, start the services: ```docker compose up```
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm using local Postgres instance, is this docker compose up cmd necessary every time you want to run the dummy app or just once after booting your machine?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As long as it's not being shut down, it's not necessary each time. However, running it won't hurt.
I see on 'bin/init':

  if use_docker == 'y'
    header 'Stopping the Docker image'
    run! 'docker-compose stop'
  end

I guess that's there for a reason, but that's also stopping 'bin/dev' to work when choosing 'use_docker' on 'bin/init' without bringing the services up. As a user, I guess it'd be ideal to just do 'bin/init' and 'bin/dev' and have dependences installed and started but that wasn't my experience with the current setup.

4. Run `bin/dev` from the root directory, which will start an overmind (similar to foreman) process for the rails server, jsbundling and cssbundling.
5. Navigate to `localhost:3030` and enjoy the app.

## Seeding the database for local development

Expand Down
2 changes: 0 additions & 2 deletions docker-compose.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
version: '3.2'

volumes:
avo-db-data:
external: true
Expand Down