https://github.com/heyheychicken/no-clock
A customizable clock, able to display all your notifications, made with Node.js.
https://github.com/heyheychicken/no-clock
lametric
Last synced: 12 months ago
JSON representation
A customizable clock, able to display all your notifications, made with Node.js.
- Host: GitHub
- URL: https://github.com/heyheychicken/no-clock
- Owner: HeyHeyChicken
- License: other
- Created: 2021-12-30T14:07:35.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-02-06T15:44:40.000Z (over 2 years ago)
- Last Synced: 2024-05-01T16:42:00.555Z (about 2 years ago)
- Topics: lametric
- Language: JavaScript
- Homepage:
- Size: 1.97 MB
- Stars: 24
- Watchers: 3
- Forks: 7
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
**No-Clock** is a customizable clock, able to display all your notifications, made with Node.js.
Hey, I recently added animated icons 😀
## Installation
1) Clone it directly from GitHub.
```
git clone https://github.com/HeyHeyChicken/No-Clock.git
```
2) Install packages
```
cd No-Clock-main
npm install
```
## Usage
1) Launch this command.
```
node index.js
```
2) If you start the launcher for the first time, it will generate you an API key used to send notifications to your device.
## Features
1) Your clock shows you the time, specifying the seconds or not, the day of the week and the day of the month.
2) You can ask it to display a notification with a POST request at http://localhost/notification.
You'll have to set the "api-key" attribute in the header.
Finaly, you'll have to set the body like this:
```json
{
"icon": {
"x": 1,
"y": 1,
"value": "hourglass"
},
"message": {
"x": 11,
"y": 1,
"value": "8 minutesand 23 seconds remaining"
},
"remaining_time": 5,
"sound": "https://dm0qx8t0i9gc9.cloudfront.net/previews/audio/BsTwCwBHBjzwub4i4/audioblocks-bells-positive-sound_BKqfVgMUAvU_NWM.mp3"
}
```
## Compatibility
**No-Clock** has only been officially tested on Chromium based browser and Android.
## License key
**The license key is obligatory.**
If you use **No-Clock** for purposes not intended toward monetary compensation such as, but not limited to, teaching, academic research, evaluation, testing and experimentation, pass the phrase `'non-commercial-and-evaluation'` in the "/settings.json" file, as presented below:
```json
{
"licenseKey": "non-commercial-and-evaluation"
}
```
The license key is validated in an offline mode.
No connection is made to any server.
Created by [Antoine Duval (HeyHeyChicken)](//antoine.cuffel.fr) with ❤ and ☕ (chocolate) in [Mesnil-Panneville](//en.wikipedia.org/wiki/Mesnil-Panneville).
