MagicMirror README

The project's README from github.com/MagicMirrorOrg/MagicMirror. As one markdown file: README.md.

MagicMirror²: The open source modular smart mirror platform.

License GitHub Actions Build Status GitHub Stars

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!

Animated demonstration of MagicMirror²

Documentation

For the full documentation including installation instructions, please visit our dedicated documentation website: https://docs.magicmirror.builders.

Contributing Guidelines

Contributions of all kinds are welcome, not only in the form of code but also with regards to

For the full contribution guidelines, check out: https://docs.magicmirror.builders/about/contributing.html

Enjoying MagicMirror? Consider a donation!

MagicMirror² is Open Source and free. That doesn't mean we don't need any money.

Please consider a donation to help us cover the ongoing costs like webservers and email services. If we receive enough donations we might even be able to free up some working hours and spend some extra time improving the MagicMirror² core.

To donate, please follow this link.

MagPi Top 50

MagicMirror (MagicMirrorOrg/MagicMirror)

Searching Database…

What is this?MagicMirror2 is an open source modular smart mirror platform that turns a hallway or bathroom mirror into a personal assistant display, showing modules like weather, calendar, and news behind a two-way mirror glass.
Is this a standalone app or a framework I build on?It's a modular application built with Electron as the display wrapper, so it runs as a desktop app with no separate web server or browser install needed, and you extend it by installing or writing modules.
How do I get it running?Follow the installation instructions on the dedicated documentation website, then run it via npm scripts (e.g. 'install-mm' to install production dependencies and 'start' to launch).
What do I need before installing it?You need Node.js (version >=22.21.1 =24) and npm; for development/testing it also installs Playwright with Chromium.
Does it only run on a Raspberry Pi behind a mirror, or can I use it elsewhere?It's commonly built into Raspberry Pi based mirror setups, but since it runs on Node.js and Electron it works cross-platform on any machine that can run those, not just a Pi.
Can I add custom features myself?Yes, MagicMirror2 is built around a modular plugin system, so you can write your own modules or install community-made ones to add new widgets to the mirror display.
Do I need a physical two-way mirror to try this?No, the software itself just runs as an Electron app showing modules on screen; the two-way mirror glass and frame are a separate hardware build you add afterward.
Why Electron instead of a web server and browser?The project switched to Electron as the application wrapper so users don't need to run a separate web server or install a browser to view the mirror interface.
Size
26.9 MB
Stars
24.1K
Age
12y
Commits · 90 Days