https://github.com/friegger/synoptico

https://github.com/friegger/synoptico

electron elm frp

Last synced: about 2 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/friegger/synoptico
• Owner: friegger
• License: apache-2.0
• Created: 2017-01-26T21:59:59.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2022-12-07T17:45:54.000Z (about 2 years ago)
• Last Synced: 2024-04-15T07:27:09.335Z (9 months ago)
• Topics: electron, elm, frp
• Language: Elm
• Size: 600 KB
• Stars: 3
• Watchers: 1
• Forks: 1
• Open Issues: 10
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Synoptico

Synoptico is a small desktop application that can aggregate multiple websites.

The goal of the project is mainly to get familiar with Elm, Electron and Bacon.js, how they can be

used together and to learn more about functional programming techniques in general. Feedback is very

welcome.

# Usage

1. Create a `json` file describing the URLs to aggregate. The [releases](https://github.com/friegger/synoptico/releases) reference a `sample.json` file with

   the required format.

2. Open the file via the `Open File...` menu entry or just drag it onto the app window. 

# Development

## How to run locally

It has been tested with Node.js 6+.

```

$ npm install

$ npm run elm #-> compiles the Elm code

$ npm start

```

## How to run the tests

```

$ npm install #-> only required once

$ npm test #-> executes the JS and the Elm tests

```

## Building

```

$ cd app

$ npm install

$ cd ..

$ npm run package-linux

$ npm run package-darwin

$ npm run package-windows

```