Sha256: d4a5bd4b01261ae49872cfc5a143c795bd42149d0dade726a4dd0ea7a62dc7d1

Contents?: true

Size: 1.8 KB

Versions: 12

Compression:

Stored size: 1.8 KB

Contents

# 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](https://github.com/code-and-effect/effective_datatables) gem.

Please download and install the [Twitter Bootstrap4](http://getbootstrap.com)

Add to your Gemfile:

```ruby
gem 'haml-rails'
gem 'effective_mentorships'
```

Run the bundle command to install it:

```console
bundle install
```

Then run the generator:

```ruby
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:

```ruby
rake db:migrate
```

Please add the following to your User model:

```
```

Add a link to the admin menu:

```haml
- 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):

```ruby
```

## License

Copyright [Code and Effect Inc.](http://www.codeandeffect.com/)

## Testing

Run tests by:

```ruby
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

Version data entries

12 entries across 12 versions & 1 rubygems

Version Path
effective_mentorships-0.3.4 README.md
effective_mentorships-0.3.3 README.md
effective_mentorships-0.3.2 README.md
effective_mentorships-0.3.1 README.md
effective_mentorships-0.3.0 README.md
effective_mentorships-0.2.4 README.md
effective_mentorships-0.2.3 README.md
effective_mentorships-0.2.2 README.md
effective_mentorships-0.2.1 README.md
effective_mentorships-0.2.0 README.md
effective_mentorships-0.1.0 README.md
effective_mentorships-0.0.1 README.md