Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kapsolas/MMM-Instagram
https://github.com/kapsolas/MMM-Instagram
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/kapsolas/MMM-Instagram
- Owner: kapsolas
- Created: 2016-07-23T17:19:00.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2023-02-22T21:03:23.000Z (over 1 year ago)
- Last Synced: 2024-06-29T09:36:16.601Z (5 months ago)
- Language: JavaScript
- Size: 879 KB
- Stars: 39
- Watchers: 9
- Forks: 12
- Open Issues: 15
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-mmm - **MMM-Instagram**
README
# MMM-Instagram
This a module for the [MagicMirror](https://github.com/MichMich/MagicMirror/tree/develop). It pulls photos from your own or another users Instagram feed (requires API_KEY). The photos are then rotated and animated in the screen.
## Installation
1. Navigate into your MagicMirror's `modules` folder and execute `git clone https://github.com/kapsolas/MMM-Instagram.git`. A new folder will appear, navigate into it.
2. Execute `npm install` to install the node dependencies.
## Config
The entry in `config.js` can include the following options:
{
module: 'MMM-Instagram',
position: 'top_left',
config: {
access_token: '1160247792.b119586.49fa97770ee34deb92e621069c760cee',
count: 200,
min_timestamp: 0,
animationSpeed: 2500,
updateInterval: 12000
}
|Option|Description|
|---|---|
|`access_token`|Access token which is received from Instagram
**Type:** `string`
This value is **REQUIRED**|
|`count`|Number of pictures to pull from the feed.
This value is **REQUIRED**|
|`min_timestamp`|Set to 0 to pull images from when you created the account.
This value is **REQUIRED**|
|`animationSpeed`|How long the fade out and fade in of photos should take.
This value is **REQUIRED**|
|`updateInterval`|How long before refreshing image list.
This value is **REQUIRED**|
Here is an example of an entry in `config.js`
```
{
module: 'MMM-Instagram',
position: 'top_right',
config: {
access_token: 'API_KEY from instagram',
count: 200,
min_timestamp: 0,
animationSpeed: 2500,
updateInterval: 12500
}
},
```
## Dependencies
- [request](https://www.npmjs.com/package/request) (installed via `npm install`)
## Important Notes
- This is one of my first projects using Node, so feel free to submit pull requests or post on the issues/wiki and I will do my best to improve the project.
## Special Thanks
- [Michael Teeuw](https://github.com/MichMich) for creating the awesome [MagicMirror2](https://github.com/MichMich/MagicMirror/tree/develop) project that made this module possible.
- [Sam Lewis](https://github.com/SamLewis0602/) for creating the [MMM-Traffic](https://github.com/SamLewis0602/MMM-Traffic) module that I used as guidance in creating this module.
## Donations Welcome
- DOGE - DDNabBuKR9EkHzf1fmfRm8Q5aMvnU9s97k
- BTC - bc1q53ntv3hqtch2yf50pupjaqayd27cz53k53cj7j
- ETH - 0x6F8D49cbc1024Ab2FBcF1F0235601B70A36489dD
- MATIC - 0x6F8D49cbc1024Ab2FBcF1F0235601B70A36489dD