https://github.com/luismeyer/nordakademie-calendar

nordakademie-calendar is an AWS Lambda that downloads the current Nordakademie timetable and formats the calendar entries every 6 hours
https://github.com/luismeyer/nordakademie-calendar

aws-lambda nak nodejs nordakademie serverless stundenplan timetable

Last synced: 8 days ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/luismeyer/nordakademie-calendar
• Owner: luismeyer
• Created: 2020-01-16T08:27:31.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2023-01-09T23:55:22.000Z (almost 2 years ago)
• Last Synced: 2024-10-05T13:22:09.100Z (3 months ago)
• Topics: aws-lambda, nak, nodejs, nordakademie, serverless, stundenplan, timetable
• Language: TypeScript
• Homepage:
• Size: 30.7 MB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 11
• Metadata Files:
  • Readme: readme.md

Awesome Lists containing this project

README

        
# Nordakademie-Calendar 📆

[![build shield](https://img.shields.io/github/workflow/status/luismeyer/nordakademie-calendar/Deploy%20master/master)](https://github.com/luismeyer/nordakademie-calendar/actions)

[![issues shield](https://img.shields.io/github/issues/luismeyer/nordakademie-calendar)](https://github.com/luismeyer/nordakademie-calendar/issues)

![repo size shield](https://img.shields.io/github/repo-size/luismeyer/nordakademie-calendar)

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://.s3.eu-central-1.amazonaws.com/**. 
 You can either download the file from there or subscribe to the Url using for example [Outlook](https://support.microsoft.com/en-us/office/import-or-subscribe-to-a-calendar-in-outlook-on-the-web-503ffaf6-7b86-44fe-8dd6-8099d95f38df) or [Google](https://support.google.com/calendar/answer/37100).

## Installation and Setup 🏁

Install [serverless](https://serverless.com) to manage the AWS deployments

and the package manager yarn.

```bash

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.

```bash

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](./secrets/readme.md))

## 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:

```bash

yarn start

```

Invoke functions like this:

```bash

yarn invoke:timetable

yarn invoke:mensa

yarn invoke:bot

```

For further instruction on using different resources see this [file](resources/readme.md).

## 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:

```bash

serverless deploy

```

## License 👨‍⚖️👩‍⚖️

[MIT](https://choosealicense.com/licenses/mit/)