Skip to content

JHWelch/MMM-Chore-Manager

Repository files navigation

MMM-Chore-Manager

This is a module for the MagicMirror².

Integration for Chore Manager web application.

Screenshot of the application in use.

Installation

In ~/MagicMirror/modules

git clone https://github.com/JHWelch/MMM-Chore-Manager.git

Install NPM dependencies

cd MMM-Chore-Manager
npm install

Using the module

To use this module, add the following configuration block to the modules array in the config/config.js file:

var config = {
    modules: [
        {
            module: 'MMM-Chore-Manager',
            config: {
                // See below for configurable options
            }
        }
    ]
}

Configuration options

Option Description
apiUrl Required URL to api, should end without slash. http://example.com/api
apiKey Required Api Key for Chore Manager instance.
teamId Required Team for whom to show chores.
updateInterval Optional Resfresh time in milliseconds
Default 60000 milliseconds (1 minute)

Testing

There is a test suite using Jest.

npm test

About

Magic Mirror integration for Chore Manager

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages