Effective Mentorships

Mentorship program to match mentors and mentees.

Getting Started

This requires Rails 6+ and Twitter Bootstrap 4 and just works with Devise.

Please first install the effective_datatables gem.

Please download and install the Twitter Bootstrap4

Add to your Gemfile:

gem 'haml-rails'
gem 'effective_mentorships'

Run the bundle command to install it:

bundle install

Then run the generator:

rails generate effective_mentorships:install

The generator will install an initializer which describes all configuration options and creates a database migration.

If you want to tweak the table names, manually adjust both the configuration file and the migration now.

Then migrate the database:

rake db:migrate

Please add the following to your User model:

</code>

Add a link to the admin menu:

- if can? :admin, :effective_mentorships
  = nav_link_to Effective::MentorshipCycle, effective_mentorship.admin_mentorship_cycles_path

Configuration

As an admin, visit the Mentorship Cycles, and groups

Authorization

All authorization checks are handled via the effective_resources gem found in the config/initializers/effective_resources.rb file.

Permissions

The permissions you actually want to define are as follows (using CanCanCan):

</code>

License

Copyright Code and Effect Inc.

Testing

Run tests by:

rails test

Contributing

  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. Bonus points for test coverage
  6. Create new Pull Request