derNiklaas / TODO-List

This is an open source TODO List written in JavaScript

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Todo List

Installation

  1. Download this repository.
  2. Make sure that you have Node.JS installed.
  3. Open a console and run npm install.
  4. Yaaay. \o/

Usage

  1. Open a console and run npm run start.
  2. Create a browser source in OBS with the following URL: http://localhost:9999/.

You can now use POST requests to community with the server. See "Socket Messages" for more information. Alternatively you can open the web interface: http://localhost:9999/interface.

If you want to use an Auto Hotkey script, gewi made a script which can be found here.

Ports

The Todo list uses the following ports:

  • 9999: The port which runs the two web endpoints. (can be changed in ./bin/www.js)
  • 10000: WebSocket transport server (can be changed in ./public/javascripts/webSocket.js, ./public/javascripts/interface.js, ./routes/send.js and app.js)

Socket Messages

To send a message to the server, just send a request to localhost:9999/send?function=[function]. The following functions are available:

Function Description
show Show the todo list.
hide Hide the todo list.
reload Reload the todo list.
stop Stop the program.
toggleTaskOne Toggle task one.
toggleTaskTwo Toggle task two.
toggleTaskThree Toggle task three.
toggleTaskFour Toggle task four.
settaskOne-... Change the value for task one. The text after the - is the new task text.
settaskTwo-... Change the value for task two. The text after the - is the new task text.
settaskThree-... Change the value for task three. The text after the - is the new task text.
settaskFour-... Change the value for task four. The text after the - is the new task text.

Credits

  • Sireisenblut for the background image.
  • gewi for making an Auto Hotkey Script.

About

This is an open source TODO List written in JavaScript

License:MIT License


Languages

Language:JavaScript 66.7%Language:CSS 18.8%Language:Pug 14.5%