MagicMirrorOrg/MagicMirror

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.

Summary

MagicMirror² is an open source modular smart mirror platform written in JavaScript that turns a hallway or bathroom mirror into a personal assistant display. It uses Electron as an application wrapper, so it runs as a self-contained desktop app rather than requiring a separate browser or web server install. The project is MIT licensed and maintained by a community of contributors.

What it is useful for

Engineers building domotics or smart home dashboards who want a customizable interface on a two-way mirror can use it as a base instead of writing their own UI from scratch. The modular plugin system means each display is a separate module, which makes it straightforward to drop in a custom data source for whatever the mirror should show. Because it is tagged for Raspberry Pi and ships as an Electron app, it is designed to run on a single-board computer that sits behind a mirror-and-monitor assembly.

How engineers can use it

The README does not include install commands; it directs readers to the documentation site at docs.magicmirror.builders for installation instructions and to docs.magicmirror.builders/about/contributing.html for contribution guidelines, so that is where setup starts.

From there, the typical flow is to clone the repository, install dependencies, and launch the Electron app, then add or write modules that hit local or remote APIs and register them in the configuration. Community discussion and technical support are documented on the forum at forum.magicmirror.builders, which has a dedicated core-system category for technical questions, and on Discord at discord.gg/J5BAtvx, which are the supported places to see how others have wired services together.

Engineers extending the platform can fork the repository and submit bug reports, documentation, translations, or code contributions per the published guidelines. The repository has a GitHub Actions workflow for automated tests on master, which matters when matching the project's expected test setup for pull requests.

Limitations worth flagging from the source: the README does not enumerate available modules, supported hardware, or system requirements, so verify those against docs.magicmirror.builders and the forum before planning a build.