marcel

module
Version: v2.1.0+incompatible Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Mar 19, 2018 License: MIT

README

M.A.R.C.E.L. Project

Smart Mirror (Miroir A Reflet Connecté Et Ludique)

MARCEL is a connected mirror that allows you to add plugins to display data about anything. You can for example add a weather forecast or a twitter plugin and see what the weather will be and the last tweet on a subject.

The main objective of the project is to be plug and play so anybody can add it on his own mirror and develop their own plugins.

Setup

To populate every plugins, you have to clone the repository with :

git clone --recursive

or after you have cloned the repository :

git submodule update

To update plugins, you can run :

git submodule update --rebase --remote

Content

Each directory has a specific usage.

  • back-office - Manage the plugins and their configuration
  • backend - Store the plugins and offer an API to request them
  • frontend - Web application that load the plugins
  • plugins - Links to repositories of available plugins

License

This project is licensed under the MIT License - see the LICENSE file for details

Directories

Path Synopsis
app
Package main MARCEL APIs Provide API to access medias information Host: localhost:8090 BasePath: /api/v1/ Version: 1.1 License: MIT http://opensource.org/licenses/MIT Contact: Gwennael Buchet<gwennael.buchet@gmail.com> swagger:meta
Package main MARCEL APIs Provide API to access medias information Host: localhost:8090 BasePath: /api/v1/ Version: 1.1 License: MIT http://opensource.org/licenses/MIT Contact: Gwennael Buchet<gwennael.buchet@gmail.com> swagger:meta
apidoc
Package medias Provide API to access medias information swagger:meta
Package medias Provide API to access medias information swagger:meta
app
medias
Package medias Provide API to access medias information Schemes: http, https swagger:meta
Package medias Provide API to access medias information Schemes: http, https swagger:meta
plugins
Package plugins Provide API to access plugins information swagger:meta
Package plugins Provide API to access plugins information swagger:meta

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL