Skip to content

nordakademie-calendar is an AWS Lambda that downloads the current Nordakademie timetable and formats the calendar entries every 6 hours

Notifications You must be signed in to change notification settings

luismeyer/nordakademie-calendar

Repository files navigation

Nordakademie-Calendar 📆

build shield issues shield repo size shield

Nordakademie-Calendar is an AWS Lambda that downloads the current Nordakademie timetable and formates the calendar entries every day.

Usage 📄

The calendar files can be accessed over the AWS S3 Url which looks like this: https://<BUCKET_NAME>.s3.eu-central-1.amazonaws.com/<FILE_NAME>.
You can either download the file from there or subscribe to the Url using for example Outlook or Google.

Installation and Setup 🏁

Install serverless to manage the AWS deployments and the package manager yarn.

yarn

If you want to use the bot notification and the meeting feature you have to run the setup script with your AWS Lambda Url set in the secrets file.

yarn setup

(Note that this will also decrypt the encrypted secrets file. If you dont have an encrypted secrets file yet, you have to manually create a secrets file and encrypt them. For more information see secrets)

Development 🛠

The handler.js file is the entry point of the AWS Lambda. Since some functions invoke each other or depend on other serverless services, you have to start the serverless offline server:

yarn start

Invoke functions like this:

yarn invoke:timetable
yarn invoke:mensa
yarn invoke:bot

For further instruction on using different resources see this file.

Deployment 🏗

All Code will be automatically deployed if a github release is created. If you want to deploy from your local machine and if you configured serverless correctly run:

serverless deploy

License 👨‍⚖️👩‍⚖️

MIT

About

nordakademie-calendar is an AWS Lambda that downloads the current Nordakademie timetable and formats the calendar entries every 6 hours

Topics

Resources

Stars

Watchers

Forks

Packages

No packages published