Home

This template project can be used for creating new MagicMirror² modules.

This wiki will give you an in depth overview of how to get started.

Create a new project with this template

1. Click here to create a new MagicMirror² module based on this template
2. Select an owner of the new MagicMirror² module
3. Give your module a name, the naming convention is PascalCase and prefix with MMM, like so: MMM-FooBar, in this wiki we call this your module name
4. Choose whether you want this to be a public or private repository
5. Click on Create repository to create the module

Example

Update template name

1. Replace all instances of MMM-Template with your module name
2. In package.json make the module name lowercase
3. Replace all instances of [GitHub url] with your GitHub url, like so: https://github.com/Dennis-Rosenbaum/MMM-Template
4. Replace all instances of [Module description] with the description of your MagicMirror² module
5. Replace all instances of [Author] with your name, like so: Dennis Rosenbaum
6. In MMM-Template.js, replace template.css with your module name lowercase and without the prefix, like so: foo-bar.css
7. Rename the file template.css to the same name as the previous step
8. Rename the file MMM-Template.js to your module name
9. Start building your awesome MagicMirror² module