From bf393b505255a7b2dfda14f4c270e2051ae55c24 Mon Sep 17 00:00:00 2001 From: Nicolas Florentin Date: Thu, 16 Jun 2016 18:01:45 +0200 Subject: [PATCH] adds a section for plugins --- README.md | 20 ++++++++++++++++++-- 1 file changed, 18 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 9ac11a31c..a889fa0fc 100644 --- a/README.md +++ b/README.md @@ -27,8 +27,9 @@ FabManager is the FabLab management solution. It is web-based, open-source and t 7.2.1. [Settings](#i18n-settings)
7.2.2. [Applying changes](#i18n-apply) 8. [Open Projects](#open-projects) -9. [Known issues](#known-issues) -10. [Related Documentation](#related-documentation) +9. [Plugins](#plugins) +10. [Known issues](#known-issues) +11. [Related Documentation](#related-documentation) @@ -554,6 +555,21 @@ To start using this awesome feature, there are a few steps: Go to your projects gallery and enjoy seeing your projects available from everywhere ! That's all. + +## Plugins + +Fab-manager has a system of plugins mainly inspired by [Discourse](https://fablab.lacasemate.fr/#!/projects) architecture. + +It enables you to write plugins which can: +- have its proper models and database tables +- have its proper assets (js & css) +- override existing behaviours of Fab-manager +- add features by adding views, controllers, ect... + +To install a plugin, you just have to copy the plugin folder which contains its code into the folder `plugins` of Fab-manager. + +You can see an example on the [repo of navinum gamification plugin](https://github.com/LaCasemate/navinum-gamification) + ## Known issues