readme.md

MagicMirror² Module: MMM-dribbble

Dribbble - Show and tell for designers.

Table of contents

• Installation
• Configuration
• dribbble API
• License

Installation

1. Download MMM-dribbble module
2. Place MMM-dribbble folder into MagicMirror/modules folder
3. Add MMM-dribbble module to modules in MagicMirror/config/config.js

MagicMirror/config/config.js

modules: [
	{
		module: "MMM-dribbble",
		position: "lower_third",
		config: {

		}
	},
],

Configuration

Key	Description	Default	Type
base	dribbble API base url	https://api.dribbble.com/v1	String
clientAccessToken	dribbble API client access token	null	String
endpoint	dribbble API shots endpoint	shots	String
perPage	shots to show	24	Integer (min: 0, max: 100)
animationSpeed	Animation speed to show content (in ms)	1 s	Integer
initialLoadDelay	Delay until shots are initially fetched (in ms)	2.5 s	Integer
updateInterval	Interval in which shots are updated (in ms)	10 min	Integer

base: "https://api.dribbble.com/v1",
clientAccessToken: null,
endpoint: "shots",
perPage: 24,
animationSpeed: 1000,
initialLoadDelay: 1000 * 2.5,
updateInterval: 1000 * 60 * 10,

dribbble API

1. Head over to the dribbble developer API and register an application.

2. Create a new dribbble application. You can put in any information you like to.

3. Copy your Client Access Token.

License

MIT License

Copyright (c) 2017 Marco Biedermann