MagicMirror/README.md
Michael Teeuw 899d05bc32 Add server (web/socket), create socket system, better helper loader.
- The Magic Mirror is now hosted via a express server, allowing you to
load it from an external client (for debugging.)
- It now includes a socket system to communicate between the
node_helper and the client module.
- node_helpers are now only loaded if the module is configured in the
config.
2016-03-30 12:20:46 +02:00

801 B

MagicMirror V2

This version of the Magic Mirror software focusses on a modular plugin system. Besides that, the Magic Mirror software now also uses Electron, so no more webserver or browser installs necessary.

#WARNING: THIS VERSION IS IN A VERY EARLY STAGE. IT IS NOT COMPLETED YET. PLEASE USE THE MASTER BRANCH.

##Usage

  1. Install Node.js
  2. Execute npm install && npm start.

##Configuration

  1. Duplicate config/config.js.sample to config/config.js.
  2. Modify your required settings.

##Todo Things that still have to be implemented or changed. ####Loader

  • Loading of module uses eval(). We might want to look into a better solution. loader.js#L112.