CVT

CVT: Continuously variable transmission

Torrent remote downloader (using transmission daemon)

Development

Requirements

rbenv

• Install rbenv (ex.brew install rbenv)
• Install ruby-build (ex.brew install ruby-build)
• (Optional) Install rbenv-vars plugin
• (Optional) Install rbenv-gem-rehash plugin

Ruby version

• Install the desired ruby version using rbenv install $(cat .ruby-version)

bundler

• Install bundler using gem install bundler

Postgres (for local.dev)

• Install Postgres (ex.brew install postgres)
• Create Postgres User and Grant him super user privilages

$ createuser -s postgres

Setup

local.dev

• Clone the repo
• Install the gems using

bundle install

• Add .env file similar to the provided .env.example
• Run bundle exec rake db:setup
• Run the server

$ bundle exec puma -e development -C config/puma.rb
$ bundle exec rails s -b 0.0.0.0

docker.dev

• Clone the repo
• Add .env file similar to the provided .env.example
• Build the docker dependencies docker-compose build
• Run docker-compose run app rake db:setup
• Run the server docker-compose up

RSpecs

• Run the specs (test suite) using rspec

$ bundle exec rspec
$ docker-compose run app rspec

Mutant Testing

$ RAILS_ENV=test bundle exec mutant -r ./config/environment --use rspec ClassName

replace ClassName with the name of the class to run mutant testing against

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/mad-raz/

This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

• Read the previous code of conduct once again.
• Write clean code.
• Write clean tests.
• Make sure your code is covered by test. (check coverage mentioned earlier)
• Make sure you follow the code style mentioned by rubocop (run bundle exec rubocop)
• A pre-commit hook included with repo can be used to remember rubocop it won't disable commits, but will remind you of violations. you can set it up using chmod +x pre-commit && cp pre-commit .git/hooks/
• Be nice to your fellow human-beings/bots contributing to this repo.

License

The project is available as open source under the terms of the MIT License