docs: Update local setup docs

[divagueame]

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.

[Paul-Bob]

Thanks for this contribution @divagueame!

I have some questions

[Paul-Bob]

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

[divagueame]

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?

[Paul-Bob]

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.

[Paul-Bob]

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?

[divagueame]

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.

[github-actions]

This PR has been marked as stale because there was no activity for the past 15 days.

[github-actions]

Closing this because there was no activity for the past 15 days. Feel free to reopen if new information pops up ✌️

[Paul-Bob]

@divagueame I reverted the changes to CONTRIBUTING.md and started working on some improvements around it here: #4114

Thanks for this contribution! I’ll merge the obsolete version removal.