https://github.com/peternewnham/ferdinand

Web service aggregator with built in notifications
https://github.com/peternewnham/ferdinand

Last synced: about 1 month ago
JSON representation

Web service aggregator with built in notifications

• Host: GitHub
• URL: https://github.com/peternewnham/ferdinand
• Owner: peternewnham
• License: mit
• Created: 2019-12-10T14:33:48.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2022-12-31T04:51:54.000Z (almost 2 years ago)
• Last Synced: 2024-06-14T21:00:55.623Z (6 months ago)
• Language: TypeScript
• Size: 778 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 20
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Ferdinand

**Note:** currently just tested/works on Debian based Linux distributions with lots of work to make it production ready

## Configuration

* After installation:

  * Create services file at `~/.config/Ferdinand/services.json` (see below for details)

  * Open Ferdinand

  * Log in to accounts for each session (if 3 services use the same session/account then only logging in to one is sufficient)

  * Restart Ferdinand

  

## Configuring services.json

### API

The `services.json` file should contain an array of objects with each object describing the service to enable.

Each service is defined by an object which can have the following properties:

* `type` - the type of service (see Services section below for values to use)

* `session` (optional) - the session to use for this service. Multiple services can use the same session.

* `muted` (optional) - true to not show notifications for this service

### Example

```ts

[

  {

    "type": "gmail",

    "session": "work"

  },

  {

    "type": "calendar",

    "session": "work"

  },

  {

    "type": "hangoutschat",

    "session": "work"

  },

  {

    "type": "hangouts",

    "session": "work"

  },

  {

    "type": "whatsapp",

    "session": "personal"

  },

  {

    "type": "gmail",

    "session": "personal",

    "muted": true

  }

]

```

  

## Supported Services

* Gmail (gmail)

* Google Calendar (calendar)

* Hangouts Classic (hangouts)

* Hangouts Chat (hangoutschat)

* Whatsapp (whatsapp)