Roda & Sequel

API skeleton using roda and sequel.

Dependencies

• rvm or rbenv
• Ruby 2.6
• Bundler
• Docker
• docker-compose

Setting Up

$ gem install bundler && bundle install
$ docker-compose up -d database
$ bundle exec rake db:setup

Running It Locally

$ rerun "rackup -p 3000"

Running Tests

$ docker-compose up -d database
$ RACK_ENV=test bundle exec rake db:setup
$ rake # or "bundle exec rspec"

After running the test suite, the coverage report is on the coverage/index.html file.

Dev Tools

To see all available tasks, run bundle exec rake -T.

Besides, there is some binary files, that allows you to run an app console or db console. To run them, execute bin/_<command>_

Code Style

Use rubocop to verify the code style:

$ bundle exec rubocop

Code Quality

Use rubycritic to generate a report about the overall code quality:

$ bundle exec rake dev:rubycritic

Code Documentation

Use yard to generate the code documentation:

$ bundle exec rake dev:yard

Contributing

1. Clone/Fork the project!
2. Create your feature branch: git checkout -b my-new-feature
3. Commit your changes: git commit -am 'Add some feature'
4. Push them: git push origin my-new-feature
5. Open a merge request :D