https://github.com/ngnijland/mmm-social-counter

This Magic Mirror module shows the follower count of a twitter user or youtube account.
https://github.com/ngnijland/mmm-social-counter

counter followers magicmirror magicmirror2 subscribers twitter youtube

Last synced: 14 days ago
JSON representation

This Magic Mirror module shows the follower count of a twitter user or youtube account.

• Host: GitHub
• URL: https://github.com/ngnijland/mmm-social-counter
• Owner: ngnijland
• License: mit
• Created: 2020-07-29T19:54:35.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2023-07-18T23:05:40.000Z (over 1 year ago)
• Last Synced: 2024-05-02T02:25:23.080Z (8 months ago)
• Topics: counter, followers, magicmirror, magicmirror2, subscribers, twitter, youtube
• Language: JavaScript
• Homepage:
• Size: 92.8 KB
• Stars: 4
• Watchers: 1
• Forks: 2
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# MMM-social-counter

This MagicMirror module is a twitter follower counter.

![Screenshot of module](https://github.com/ngnijland/MMM-social-counter/raw/master/screenshots/MMM-social-counter-screenshot.png)

## Installation

1. Go to the MagicMirror modules folder

```bash

cd ~/MagicMirror/modules

```

2. Clone this repository

```bash

git clone https://github.com/ngnijland/MMM-social-counter.git

```

3. Add this module to the modules array in the MagicMirror `config/config.js` file, like this:

```javascript

modules: [

  {

    module: "MMM-social-counter",

    position: "middle_center"

  }

]

```

## Twitter

To show the follower count of a Twitter user you need an app in the Twitter Developer Portal.

1. Go to: https://developer.twitter.com/

2. Log into your Twitter account

3. Go to the apps overview in the `Developer Portal` (https://developer.twitter.com/en/portal/projects-and-apps)

4. Create a new app

5. Add the `API key` and `API key secret` to the config of this module as follows:

```javascript

modules: [

  {

    module: "MMM-social-counter",

    position: "middle_center",

    config: {

      twitter: {

        apiKey: '',

        apiKeySecret: '',

        username: ''

      }

    }

  }

]

```

## Configuration

Configure this module in your MagicMirror config file which is located at `config/config.js` in the MagicMirror repository. An example config for this module:

```javascript

modules: [

  {

    module: "MMM-social-counter",

    position: "middle_center",

    config: {

      // Options

    }

  }

]

```

The following configurations are available:

Config                | Type                       | Default value | Description

:---------------------|:---------------------------|:--------------|:------------

`size`                | `small \| medium \| large` | `medium`      | The size of the counter

`icon`                | `string`                   | `fa-twitter`  | The name of the font (from FontAwesome) to use as the icon next to the follower count, e.g. fa-twitter-square

`updatesEvery`        | `number`                   | `10`          | The number of seconds between each follower count update