ensl.org/DEVELOPMENT.md
Ari Timonen 43aa3ad587 Docs
2020-03-22 19:44:09 +02:00

1.8 KiB

Development

Install instructions in INSTALL.md

Startup

Just run and open http://localhost:4000/

docker-compose -f docker-compose.dev.yml up`

Tips

  1. Everything should be running on containers.
  2. If you need to run stuff on your host (eg. ruby, rubocop, bundle install etc) run all commands from the: Dockerfile.dev. It should setup identical setup for your machine.
  3. Add docker container names to /etc/hosts. This makes it possible to run test from local machine without using the container since editor/IDE don't integrate with Docker so well. sudo echo docker inspect -f '{{range .NetworkSettings.Networks}}{{.IPAddress}}{{end}}' ensl_dev_db db >> /etc/hosts
  4. VS Code and RubyMine are great IDE's/editors.
  5. To run VS Code plugin Ruby Test Explorer in docker container you need to create path to custom
  6. Do not commit too much without testing. Also keep commits small for documentation and reversability issues.

Best practices

  1. https://nvie.com/posts/a-successful-git-branching-model/
  2. https://github.com/rubocop-hq/ruby-style-guide
  3. https://rails-bestpractices.com/
  4. http://www.betterspecs.org/
  5. https://github.com/rubocop-hq/rspec-style-guide
  6. Run rubocop

Handy commands

To get inside docker web+test containers: docker-compose -f docker-compose.dev.yml exec -u root web /bin/bash docker-compose -f docker-compose.dev.yml exec -u web web /bin/bash docker-compose -f docker-compose.dev.yml exec -u root test /bin/bash docker-compose -f docker-compose.dev.yml exec -u web test /bin/bash Restart the web container docker-compose -f docker-compose.dev.yml restart web Run some tests: docker-compose -f docker-compose.dev.yml exec -u web test bundle exec rspec docker-compose -f docker-compose.dev.yml exec -u web test bundle exec rspec spec/controllers/shoutmsgs_controller_spec.rb`