Giter VIP home page Giter VIP logo

change-notifier's Introduction

Change Notifier

How the project is going on? Does it build? When has it been done? Where can it be used? Downloads?

What is this?

I would really love to have such an app that could notify me when something changes on a the teacher's website.

That's something I used to say regularly during University, while waiting for a teacher to post up test results and stuff like that. So, two ears later, in my last year there, as an experiment, I crafted this simple application that, given a website (page), notifies you of each change on that website. Too bad I did not got to use it so much.

It's built with Electron for Windows and it's capable of running diffs on the page you provide and show you only what's changed, using native notifications.

Developer(s) thingies

Using the code

  • npm start to run the application (it uses bootstrapper.js as startup, which loads the application first transpiling using babel)
  • The code is organized as follows:
    • The directories style, js, img and the file index.html are all the required stuff for the front-end;
    • boottrapper.js, main.js and everything inside scripts directory is the backend

Main Tech

  • JavaScript (ES2015 with Babel)
  • Node.JS (v4)
  • Electron (v1.4)

Packeges Used

General
  • babel-register (v6.3) and babel-preset-es2015(v6.3)

    for transforming ES2015 code into Node compatible code (Node wasn't supporting this back then)

  • eslint (v3) and eslint-config-es2015(v1)

    for code parsing / validation

  • electron (v1.4)

    embedding Node.JS Applications into a nice WebView and run them on Windows (this case) platform

Frontend
  • materialize

    Frontend framework

  • jQuery (v3.1)

    DOM handling & extras

  • lodash (v4.16)

    Array & Object handling

  • sweetalert (v1.1)

    beautiful alerts for users

Backend
  • Node.js (v4)

    you know what it is

  • zombie (v5.0)

    headless browser, for virtual navigation to websites

  • diff (v3.0)

    for getting just the differences between different page eversions

  • node-notifier (v4.6)

    for displaying native (Windows) notifications

Using the Application

  1. Start the application, after downloading it from here, from change-notifier.exe file
  2. Insert, in the big input from the main screeen, the address of the web page you want to check
  3. Specify the interval (in seconds) in which you want the check to repeat itself.
  4. Toggle the switch to make everything running. Then you are done, you can minimize it, the application will check the address you specified at the given interval and will notify you if something changes (and what changes).

PS: If your computer has notifications turned off, then - ofc - notifications will not pop-up.

System Requirements

  • Hardware: Laptop/PC
  • Operating System: Windows
  • RAM: 1 GB
  • CPU: any decent one

Video Demo

Demo video

License

Released under MIT License

change-notifier's People

Contributors

marianfx avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.