Home

Awesome

Build Status Code Climate Test Coverage

Mumukit

Micro framework for quickly implement Mumuki runners

TL;DR

The best way to start using mumukit is with mumukit-bootstrap, and reading our online documentation in develop.mumuki.io

Installing

You usually add mumukit to an empty project. First you need to add it to your Gemfile:

gem 'mumukit'

or, if you want latest version:

gem 'mumukit', github: 'mumuki/mumukit', branch: 'master'

And then bundle install

Ruby Version

mumukit works with Ruby 2.0-2.3

Getting started

Seed

The easiest way of getting started is by using using the seed/seed.sh script.

  1. Clone this project in a clean directory: git clone https://github.com/mumuki/mumukit
  2. Go to seed directory: cd mumukit/seed
  3. Run the script: ./seed.sh
  4. Follow instructions.

Hooks

mumukit is a framework where nearly everything is a hook - a class you must implement following some naming and method conventions. In order to implement a Mumuki Runner with mumukit, you need zero or more of the following:

Components

In addition, mumukit provides some components to make implementation of hooks easier:

Templates

Also, mumukit provides templates that implement some specialized use cases hooks:

Extensions

Finally, mumukit templates provides the following extensions - features that can be activated in some hooks:

Server extensions

If you need to serve assets, you can include the Mumukit::Server::WithAssets mixin which enables cross origin requests and provides get_asset and get_local_asset methods