Update README to explain how to run rails commands from the terminal #472
Conversation
- previously, one had to ssh into the docker container to track byebug or run the rails console - create a psudoterminal to the api docker container and allow input for it - update readme to explain how to run the rails console and byebug - https://stackoverflow.com/questions/31669226/rails-byebug-did-not-stop-application/32690885#32690885 - https://medium.com/@ddomachine/docker-and-ruby-on-rails-448ab8255f97
| ```sh | ||
| # Start both the DB and API | ||
| $ cd PATH/TO/askdarcel-api | ||
| $ docker-compose run --rm api rails console |
There was a problem hiding this comment.
While I think it's useful to have this here, I'm not sure whether it belongs under a section like this.
The general rule of thumb is for any command that you would normally native run, just prefix it with docker-compose run --rm api.
Also, I wasn't exactly sure what you meant by "ssh into the containers". We don't literally SSH into the containers with ssh, but the closest thing to that is executing a command within the container while attaching your terminal's stdin/stdout. But that is exactly what you are doing here with this command, which seems to conflict with the sentence you wrote at the beginning of the section.
There was a problem hiding this comment.
Good points. I have updated the wording to be, hopefully, correct and removed the contradictions.
I renamed the section to be Developer Tools; do you think that is a better section have.
README.md
Outdated
| #### Running byebug from the terminal | ||
| ```sh | ||
| # Start both the DB and API | ||
| $ docker attach $(docker ps -aqf "name=askdarcel-api_api") |
There was a problem hiding this comment.
It might be worth describing this in a lot more detail. For people who aren't familiar with byebug, this doesn't actually teach anyone how to start byebug. What this command really does is attach your TTY and stdin to an already running Docker container which is assumed to be running the Rails web server. The comment above this is actually incorrect; this command will fail if the API server is not already running.
There was a problem hiding this comment.
I have added more information; let me know if you want me to add more.
alexanderturinske
changed the title
track byebug or run the rails console
allow input for it
byebug