Skip to content

Latest commit

 

History

History
18 lines (15 loc) · 2.64 KB

README.md

File metadata and controls

18 lines (15 loc) · 2.64 KB
Raw

MagicMirror²: The open source modular smart mirror platform. Node.js CI License

MagicMirror² is an open source modular smart mirror platform. With a growing list of installable modules, the MagicMirror² allows you to convert your hallway or bathroom mirror into your personal assistant. MagicMirror² is built by the creator of the original MagicMirror with the incredible help of a growing community of contributors.

MagicMirror² focuses on a modular plugin system and uses Electron as an application wrapper. So no more web server or browser installs necessary!

Installation Instructions

  • Go to the Github repository for our Magic Mirror fork: https://github.com/YeetCodes/MagicMirror
  • Go to Releases to see all releases: https://github.com/YeetCodes/MagicMirror/releases
  • Download and extract the latest or your desired release:
  • Enter the extracted subdirectory and run the command
    chmod +x Start-Here.sh && ./Start-Here.sh
  • This will run the installation script which will check for the installation of the npm package and install it if necessary.
  • Afterwards, the script will run npm install to install the Magic Mirror application and npm start to start it.
  • Use Ctrl + Q to exit the MagicMirror application.
  • After the initial installation, the only command necessary for running the Magic Mirror application is npm start from within the directory.
    • Updating the release or application files will require a new installation.