https://github.com/droduit/horaire

[PWA] Horaire
https://github.com/droduit/horaire

less-css nodejs offline-capable push-notifications pwa service-worker

Last synced: about 10 hours ago
JSON representation

[PWA] Horaire

• Host: GitHub
• URL: https://github.com/droduit/horaire
• Owner: droduit
• License: gpl-3.0
• Created: 2019-04-28T12:24:50.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2022-12-03T07:21:17.000Z (almost 2 years ago)
• Last Synced: 2023-02-25T22:51:18.701Z (over 1 year ago)
• Topics: less-css, nodejs, offline-capable, push-notifications, pwa, service-worker
• Language: JavaScript
• Homepage: https://dominique.leroduit.com/horaire/
• Size: 1.12 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 9
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# Horaire

This Progressive Web App calculate your departure time according to your worktime, arrivals and departures.

It helps you maintain good habits with a positive hourly balance, or to raise a negative balance.

Push notifications are sent once your working time is over.

A service worker cache and fetch the cached files to provide an offline availability.

# Developers

## Install 

- [NodeJS](https://nodejs.org/)

Once NodeJS installed:

1. Install Gulp: `npm install gulp -g`

2. Open a terminal in your project root directory (containing the `package.json` file): `npm install`

### Config

- src/db_connect.php

- src/passwd.php

- Setup web push notifications: [Generate a public/private key pair](https://web-push-codelab.glitch.me/), then complete the file `src/keys.php` 

### GULP tasks

- Preprocess, minify and concatenate all css files in bundle.min.css : `gulp css`

- Concatenate, uglify and pack all javascript files as bundle.min.js : `gulp js`

- Re-generate the css/js files for production : `gulp build`

## Maintaining the project

### Updating package dependencies

- To display the outdated packages : `npm outdated`

- To keep the dependencies up to date, simply run the command `npm update`.

### Auditing package dependencies for security vulnerabilities

1. Run the command `npm audit fix`

2. Run `npm audit` and resolve manually the vulnerabilities left, if any.