Skip to content

Zeyber/master-list-cli

Repository files navigation

Master List CLI

An organizational list that leverages third-party APIs and displays information in a simple list.

Sometimes managing so many tasks can become overwhelming (eg. emails, agenda, tasks, social media, communications across multiple platforms). It is easy lose track of what needs to be done, when and how much you really need to do.

Master List CLI is a node-based solution that runs on any machine within the command line. It features connecting to APIs or feeds that can be configured to read relevant important information that the client may require.

Node: There is a browser version of the app here.

Applications

  • Communications: Monitoring incoming messages, emails, chats, etc.
  • Notifications: Monitoring generic notifications from applications.
  • Analytics: Live monitoring analytical applications (eg. Google Analytics, AWS CloudWatch, etc).
  • Agenda: Display relevant Calendar appointments.
  • To Dos and Issue Tracking: Show tasks on To Do lists or assigned Github/Atlassian Issues.

Example: Task list monitoring live data via feeds

Using Master List for tracking tasks, stats, messages and appointments on a Rasberry Pi Zero connected to a monitor.

2022-04-20 21 05 47

Installation

Download and Install

  • Clone with git clone https://github.com/Zeyber/master-list-cli. or download from Github.
  • Install packages with npm install.

Setup Feeds

Prepare you feeds that you want to show up in your list. You can create feeds and/or use pre-made feeds.

Creating a Feed

A feed is essentially a service that will return a GET response in JSON format:

{
  data: [
    {
      message: "[Message from John]: Hey buddy!"
    },
    {
      message: "[Message from Newbie]: Hello world!"
    }
  ]
}

It is up to the feed developer to host a service that delivers the required information via the endpoint. Please see the pre-made feeds below for some examples.

Pre-made Feeds

A list of feeds created by users for use with Master List.

Add your feed to settings.json

  • Open setup.json in your editor.
  • Add a feed's endpoint (and optionally an icon) to a given array like in the example below:
{
  "feeds": [
    "endpoint": "http://localhost:3000",
    "icon": "assets/my-icon.svg"
  ]
}

Build and Run

  • Build with npm run build.
  • Run with node dist/main.js.

Run in Development mode

  • Start app with npm start.

Enjoy!

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Sponsor this project

 

Packages

No packages published