Skip to content

Conversation

divagueame
Copy link

Description

This PR updates the instructions to run the dummy app locally. It was based on my own experience setting up this project on my machine.

This PR also removes the attribute version from docker-compose.yml to avoid this warning when running the docker compose services:

==========================
Creating the Docker volume
==========================

avo-db-data

=====================================
Creating and running the Docker image
=====================================

WARN[0000] /Users/divagueame/avo/docker-compose.yml: the attribute `version` is obsolete, it will be ignored, please remove it to avoid potential confusion
[+] Running 1/1
 ✔ Container avo-db-1  Running                                                                                                                                                         0.0s

======================
Preparing the database
======================

Fixes # (issue)

Checklist:

  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • I have added tests that prove my fix is effective or that my feature works

Screenshots & recording

Manual review steps

  1. Step 1
  2. Step 2

Manual reviewer: please leave a comment with output from the test if that's the case.

@divagueame divagueame force-pushed the docs/update-local-setup-docs branch from 6eb574a to c579572 Compare September 17, 2025 20:51
Copy link
Contributor

@Paul-Bob Paul-Bob left a comment

Choose a reason for hiding this comment

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

Thanks for this contribution @divagueame!

I have some questions


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

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.

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.
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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants