-
-
Notifications
You must be signed in to change notification settings - Fork 297
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.
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
base: main
Are you sure you want to change the base?
Conversation
6eb574a
to
c579572
Compare
There was a problem hiding this 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. |
There was a problem hiding this comment.
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
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
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``` |
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
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.
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:Fixes # (issue)
Checklist:
Screenshots & recording
Manual review steps
Manual reviewer: please leave a comment with output from the test if that's the case.