kenmirrors/MagicMirror
1
0
Fork 0
mirror of https://github.com/MichMich/MagicMirror.git synced 2025-06-27 11:50:00 +00:00
Code Issues Projects Releases Wiki Activity
MagicMirror/README.md
Nicholas Hubbard 9e6e34eda0 Markdown Love: Part I
2016-04-07 21:04:24 -04:00

4.4 KiB
Raw Blame History

MagicMirror²

Dependency Status devDependency Status

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

Automatic Installer

  1. Clone the repository: git clone -b v2-beta https://github.com/MichMich/MagicMirror
  2. Enter the new directory: cd MagicMirror
  3. Give the installer permission to run: sudo chmod +x install.sh
  4. Start the installer: sudo ./install.sh

Manual Installation

  1. Download the latest Node.js version:
  • wget https://nodejs.org/dist/latest/node-v5.10.0-linux-armv6l.tar.gz for Raspberry Pi
  • wget https://nodejs.org/dist/latest/node-v5.10.0-linux-armv7l.tar.gz for Raspberry Pi 2
  • wget https://nodejs.org/dist/latest/node-v5.10.0-linux-arm64.tar.gz for Raspberry Pi 3
  1. Unpack the archive file: tar -xvf filename.tar.gz
  2. Install Node.js: cd foldername && sudo cp -R * /usr/local/
  3. Set loglevel npm config set loglevel info
  4. Clone the repository and check out the beta branch: git clone -b v2-beta https://github.com/MichMich/MagicMirror
  5. Enter the repository: cd MagicMirror
  6. npm install && npm start (You may have to restart your terminal before this works!)

Important: npm start does not work via SSH, use DISPLAY=:0 nohup npm start & instead. This starts the mirror on the remote display.

Configuration

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

Todo List

Here is a list of various things that still have to be implemented or changed.

  • Allow show/hide animations to animate the height. This way, the other modules won't jump around.
  • Allow vertical centering of alerts.
  • Rewrite the alert module in vanilla JavaScript.
  • Write all the documentation.

Modules

The following modules are installed by default.

The following modules are created by their respective authors.

Module Name Author Link
FRITZ!Box Call Monitor Paul Vincent-Roll (paviro) Click Here
Facial Recognition Paul Vincent-Roll (paviro) Click Here
Wunderlist Paul Vincent-Roll (paviro) Click Here
WordNik Sam Vendittelli (SVendittelli) Click Here

Contributing

Contributions of all kinds are welcome, not only in the form of code but also with regards bug reports and documentation.

Please keep the following in mind:

  • Bug Reports: Make sure you're running the latest version. If the issue(s) still persist: please open a clearly documented issue with a clear title.
  • Minor Bug Fixes: Please send a pull request with a clear explanation of the issue or a link to the isssue it solves.
  • Major Bug Fixes: please discuss your approach in an GitHub issue before you start to alter a big part of the code.
  • New Features: please please discuss in a GitHub issue before you start to alter a big part of the code. Without discussion upfront, the pull request will not be accepted / merged.

Thanks for your help in making Magic Mirror better!