Skip to content

Latest commit

 

History

History
48 lines (32 loc) · 1.32 KB

README.md

File metadata and controls

48 lines (32 loc) · 1.32 KB
Raw

Prof Absent Notifier

prof-absent-notifier scrapes ProNote to check if any Professor is absent. If so, it will then send a notification to your Slack Channel through webhooks. It has been optimised to run on a Raspberry Pi.

Requirements

  • Node JS
  • Chome installed (Use this link if you want to run the app on a Raspberry Pi)
  • Slack workspace with webhook setup on a channel to send the notifications.

Installation

Clone the app and run to download dependencies.

npm install
# or
yarn install

Create .env file in the main directory with this format

PRONOTE_SCHOOL = "your pronote school number"
PRONOTE_USER = "Your Pronote username"
PRONOTE_PASS = "Your Pronote password"
SLACK_WEBHOOK = "slack webhook url"

Usage

To run the app once, simply use

yarn start
# or
npm run start

I prefer to run the app on a Raspberry Pi 3+ and use a cron job to make to run every morning at 6 am. To learn more about cron jobs have a look here.

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

License

MIT