Tasuku is a framework for building tasks in Ruby on Rails. It ships with an array of tasks ranging from reading articles to sharing photos. You can make your own tasks, too, and we'd love for you to contribute if you do.

Really it's up to you. Tasuku just supplies a set of models that may be completed in various ways and you can go about doing that however you like. We sometimes organize tasks in a Course model. Other times we use Feeder to mix them with other interesting things.

Add this line to your application's Gemfile:

gem 'tasuku'

And then execute:

$ bundle

Install the gem:

$ rails generate tasuku:install

Run the migrations:

$ rake db:migrate

Then you can change the default configurations:

# config/routes.rb
Rails.application.routes.draw do
  mount Tasuku::Engine, at: '/tasks'
end

And finally the method to use in deriving the model instance that solving tasks will attributed to. Typically this is a user of some kind, but it could also be a group of users.

If you're using Devise for authentication, for example, you might have a method current_user that returns the right instance of your User model:

# config/initializers/tasuku.rb
Tasuku.configure do |config|
  config.author = :current_user
end

Tasuku ships with views, but you can copy them to customize things to your liking:

$ rails generate tasuku:views

Tasuku defaults to using your application's layout, so you'll need to prefix your own route helpers with main_app so Ruby on Rails knows where to look.

1. Fork it
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create new Pull Request

Note: Remember to create the test database under spec/dummy, using bundle exec rake db:setup RAILS_ENV=test

Hyper made this. We're a digital communications agency with a passion for good code, and if you're using this library we probably want to hire you.

Tasuku is available under the MIT license. See the LICENSE file for more info.