README.md

WIT Timetable Generator

Uses Puppeteer to automatically fill out the WIT Timetable Page and generate a screenshot and PDF of the timetable. It can also send these to a Discord channel using a webhook.

Why?

Filling out the form every time is annoying, especially since it refreshes.

How do I use it?

Make sure you have Node installed.

• Clone the repo and cd into it.
• npm i
• Fill out your details in .env.local.example and rename it to .env
• Change SKIP_DISCORD in the .env file if you want to use Discord webhooks:

SKIP_DISCORD=0

• npm run start
• The timetable should be in the screenshots and pdfs folder.

Resources used

• https://stackoverflow.com/a/62892482
• https://github.com/lannonbr/puppeteer-screenshot-action
• https://birdie0.github.io/discord-webhooks-guide/
• nektos/act#588 (comment)

How do I contribute?

If it is something small, make a change directly and make a pull request.

If it is something that requires testing:

• Install act.
• Rename env.local.example to env.local
• Run act --secret-file .env.local workflow_dispatch to test changes.

License

Licensed under the MIT license.