mustached-robot/core

The core of Mustached Robot

Mustached Robot

, _(*1)

Description

Mustached Robot is an open source checkin plateform for coworking spaces., _(*2)

Development team

• Florent Gosselin - UX designer (@fgosselin)
• Jérémie Pottier - Developer (@dzey)

New developers or designers are welcome to join the project. Just contact us on twitter (@fgosselin, @dzey) if you want to get involved!, _(*3)

Roadmap

v. 0.5 (current)

• Coworkers can create an account and checkin in the coworking space
• Coworking space managers can access the coworking space datas on a beautiful dashboards: coworkers currently here, coworkers profiles, coworking space statistics
• An API is available so any allowed developer can play with the coworking space datas

v. 0.6

• Base of a plugin system that allows anyone to develop plugins and themes without needing to change the core files (example: a billing management system through Freshbook, a connection to a specific CRM, etc).

v. 1.0

• Account management for coworkers (email confirmation, lost password, etc.)
• Skills management (a coworker can add or update his skills)
• A Dashboard view with the coworkers profiles and the next events in the coworking space (this view can be used on a large TV screen in the coworking space)
• Mobile ready

Installation

See the install documentation, _(*4)

Documentation

You want to get involved? See the Developers documentation, _(*5)

API documentation

An API mini-doc is also available. Once Mustached Robot is installed and configured on a server, developers can use this API to access the coworking space datas., _(*6)

Project status and bug report

You can see the project status or report any bug on the Github issues tracker, _(*7)

Help and discussions

If you need help or if you want to talk about mustaches, you can do it on twitter or on this Google Group., _(*8)

Plugins

A plugin is an independant module which extend the capabilities of Mustached Robot by interacting at several strategic places of the application. Plugins are still under development and we may have to break backward compatibility before they are stable., _(*9)

With a plugin you can :, _(*10)

• Add anything you want on a few specific views
• Add form elements and trigger actions according to these elements on the application
• Customize the look & feel of your application

And all that without breaking your Mustached Robot installation (i.e. you will be able to update the core features and the plugin independently)., _(*11)

Develop a plugin

Plugins are FuelPHP modules. They are integrated in a project through composer., _(*12)

To developer a plugin your need to:, _(*13)

• create a specific repository for your module with a composer.json file at the root. You must specify the "type" of the package as a "fuel-module" (see composer installers documentation). This will allow composer to move the plugin in the right directory of your installation
• add the plugin as a dependency for the project in the composer.json of the project

As an example, a plugin called twitter is available on Github and integrated in the default project., _(*14)

Here are the current classes you can use:, _(*15)

• Form - It allows you to add form elements on some form of the application.
• Trigger - It allows you to do anything you want after a specific action has been done by the user (example: after a user has checked in, I want my plugin to tweet about it and send me a SMS).
• Theme - It allows you to customize the CSS and add images into the project. Each coworking space can use its own theme.

Language

All the language strings must be stored in the "language" folder of the plugin, following FuelPHP convention. We use .yml by convention., _(*16)

Configuration

You can ask for configuration parameters to the application admin by creating a "config" folder in your module and a .php file with the same name as your plugin. This config file will automatically generate a settings form for the administrators of the coworking space., _(*17)

Your config file must follow a few conventions:, _(*18)

• it must be an associative array
• the keys of the array must be the name of the parameter
• the value of the array must be another array, containing three key/value pairs: ** 'label': The label that will be displayed on the form ** 'type': The type of the field (see FuelPHP form type ** 'value': The default value of the parameter

Here is an example of a config file for the Twitter plugin:, _(*19)

'consumerKey' => 
    array(
        'value' => '',
        'type' => 'text',
        'label' => 'settings.consumerKey',
    ),
'consumerSecret' => 
    array(
        'value' => '',
        'type' => 'text',
        'label' => 'settings.consumerSecret',
    ),

If the user changes the default configuration, it will be saved into his local installation configuration file (/fuel/app/config/mustached.php), so he will be able to fully update the plugin without deleting his own parameters., _(*20)

If some users have already installed your plugin and, in a future version you decide to use some extra settings, the new settings will be made available to the user but they will keep their previous settings saved locally., _(*21)

To access a config parameter of the plugin, use the function:, _(*22)

\Mustached\Plugin::getConfig($pluginName, $configName)

• pluginName: name of the plugin
• configName: name of the config parameter (use "." as an array separator)

This function will return the parameter set by the user or, if none hase been set, the default parameter of the plugin. You should always use this function instead of the FuelPHP core function such as \Config::get();, _(*23)

Customizables forms

A few forms are customizable., _(*24)

The checkin form

If you want to configure the checkin form, create a "Form" class in your module and add the method addElementOnPublicCheckin(), _(*25)

By default, the new element(s) will be added after the last field. You can override this settings by using the two parameters (the first is the name of the element on the current form, the second is the position -- 'before' or after' -- of your new field relatively to the first parameter., _(*26)

Customizable actions

Some actions can be extended., _(*27)

Do something when user checks in

If you want to do something when a user checks in, create a "Trigger" class in your module, and add the method postCheckin(), _(*28)

This method send one argument $options with a 'fieldset' key containing the fields submitted by the user on the checkin form (if you have previously configured the checkin form, the datas added on the form by your plugin will be also available, see the twitter plugin example for reference)., _(*29)

Themes

A plugin can be used as a Theme for part or the totality of the application. A theme example is available on Github., _(*30)

CSS

To load a CSS file in the whole application, add a Theme class in your module and add a "getCss" function returning the path of the CSS file and the version number of this file:, _(*31)

public function getCss()
{                   
    return array(
        'path' => 'assets/main.css',
        'version' => 1,
    );
}

At each update of the plugin from the user (through composer), this file will be copied into the main project (in the /public/assets/css/plugins/[plugin_name]/ folder) and will be loaded in the application., _(*32)

Images

To use images in the project, insert them in an /assets/img directory. All the images in this directory will be copied in the project directory /public/assets/img/[plugin_name]/ when composer install or update will be run., _(*33)

Plugin update

A user can update the plugins by running the composer update command. This command will get the latest version of the plugin and will install the Css and the images., _(*34)