rooty/fab-manager
1
0
Fork 0
mirror of https://github.com/LaCasemate/fab-manager.git synced 2024-11-30 11:24:21 +01:00
Code Issues Releases Activity
e08157b5f6
fab-manager/README.md
Sylvain 7024c30c6c improved readme and links to documentation
2021-05-17 15:42:23 +02:00

4.2 KiB
Raw Blame History

Fab-manager

Fab-manager is the Fab Lab management solution. It provides a comprehensive, web-based, open-source tool to simplify your administrative tasks, and document your marker's projects.

Coverage Status Docker pulls Docker Build Status Crowdin

Table of Contents
  1. Software stack
  2. Contributing
  3. Documentation
  4. Open Projects
  5. Plugins
  6. Single Sign-On
  7. Related Documentation

Software stack

Fab-manager is a Ruby on Rails / AngularJS web application that runs on the following software:

  • Ubuntu LTS 14.04+ / Debian 8+
  • Ruby 2.6
  • Redis 6
  • Sidekiq 6
  • Elasticsearch 5.6
  • PostgreSQL 9.6

Contributing

Contributions are welcome. Please read the contribution guidelines for more information about the contribution process.

Documentation

The full documentation is available at doc.fab.mn.

Open Projects

This configuration is optional.

You can configure your Fab-manager to synchronize every project with the Open Projects platform. It's very simple and straightforward and in return, your users will be able to search over projects from all Fab-manager instances from within your platform. The deal is fair, you share your projects and as reward you benefits from projects of the whole community.

If you want to try it, you can visit this Fab-manager and see projects from different Fab-managers.

To start using this awesome feature, there are a few steps:

  • send a mail to contact@fab-manager.com asking for your Open Projects client's credentials and giving them the name and the URL of your Fab-manager, they will give you an App ID and a secret
  • fill in the value of the keys in Admin > Projects > Settings > Projects sharing
  • export your projects to open-projects (if you already have projects created on your Fab-manager, unless you can skip that part) executing this command: bundle exec rails fablab:openlab:bulk_export

IMPORTANT: please run your server in production mode.

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

Single Sign-On

Fab-manager can be connected to a Single Sign-On server which will provide its own authentication for the platform's users. Currently, OAuth 2 is the only supported protocol for SSO authentication.

For an example of how to use configure an SSO in Fab-manager, please read sso_with_github.md.

Related Documentation