Readme

Explain your project here.

Project settings

• If your project is private, you can host it for free in Gitlab and use their CI.
• Optionally, turn your repo on in Coveralls (coverage status), codeclimate (maintainability), and depfu (dependency status).
• If you are using codeclimate, update the default branch name in the settings area.
• Update badges with your user/repo names.
• Update license to your preferred one.

How to use this project

This is a Ruby project. Tell your Ruby version manager to set your local Ruby version to the one specified in the Gemfile.

For example, if you are using rbenv:

1. Install the right Ruby version:

rbenv install < VERSION >

1. Move to the root directory of this project and type:

rbenv local < VERSION >
ruby -v

You will also need to install the bundler gem, which will allow you to install the rest of the dependencies listed in the Gemfile of this project.

gem install bundler
rbenv rehash

Folder structure

• bin : Executables
• lib : Sources
• spec: Tests

To initialise the project

bundle install

To run the app

Make sure that the bin/app file has execution permissions:

chmod +x bin/app

Then just type:

bin/app

If this doesn't work you can always do:

bundle exec ruby bin/app

Tests

To run all tests and rubocop

bundle exec rake

To run a specific test file

bundle exec rspec path/to/test/file.rb

To run a specific test

bundle exec rspec path/to/test/file.rb:TESTLINENUMBER

To run rubocop

bundle exec rubocop

License

MIT License