Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ismarslomic/skistar-activities-ical
Skistar activities as iCal calendar
https://github.com/ismarslomic/skistar-activities-ical
magicmirror2
Last synced: about 2 months ago
JSON representation
Skistar activities as iCal calendar
- Host: GitHub
- URL: https://github.com/ismarslomic/skistar-activities-ical
- Owner: ismarslomic
- License: mit
- Created: 2023-04-23T22:57:39.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-11-11T22:15:10.000Z (about 2 months ago)
- Last Synced: 2024-11-11T23:18:48.250Z (about 2 months ago)
- Topics: magicmirror2
- Language: TypeScript
- Homepage:
- Size: 946 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
# Skistar activities exposed as iCal calendar
[](https://github.com/ismarslomic/skistar-activities-ical/actions/workflows/codeql.yml)
[](https://github.com/ismarslomic/skistar-activities-ical/actions/workflows/eslint.yml)
[](https://github.com/ismarslomic/skistar-activities-ical/actions/workflows/build.yml)
[](https://codecov.io/gh/ismarslomic/skistar-activities-ical)
> NodeJS app exposing the upcoming activities at Skistar destinations, similar to what is displayed
> at [Activities in Hemsedal](https://www.skistar.com/en/ski-destinations/hemsedal/winter-in-hemsedal/events/) as valid
> [iCalendar](https://en.wikipedia.org/wiki/ICalendar) from an HTTP endpoint.
# Example
HTTP GET http://localhost:3001/skistar_calendar.ics
```text
BEGIN:VCALENDAR
VERSION:2.0
PRODID:-//skistar.com//activities//NO
NAME:Skistar activities in Hemsedal
X-WR-CALNAME:Skistar activities in Hemsedal
BEGIN:VTIMEZONE
TZID:Europe/Oslo
TZURL:http://tzurl.org/zoneinfo-outlook/Europe/Oslo
X-LIC-LOCATION:Europe/Oslo
BEGIN:DAYLIGHT
TZOFFSETFROM:+0100
TZOFFSETTO:+0200
TZNAME:CEST
DTSTART:19700329T020000
RRULE:FREQ=YEARLY;BYMONTH=3;BYDAY=-1SU
END:DAYLIGHT
BEGIN:STANDARD
TZOFFSETFROM:+0200
TZOFFSETTO:+0100
TZNAME:CET
DTSTART:19701025T030000
RRULE:FREQ=YEARLY;BYMONTH=10;BYDAY=-1SU
END:STANDARD
END:VTIMEZONE
TIMEZONE-ID:Europe/Oslo
X-WR-TIMEZONE:Europe/Oslo
BEGIN:VEVENT
UID:4360e507-d7a4-4b45-9323-3219c1dfd2aa
SEQUENCE:0
DTSTAMP:20230423T233248
DTSTART;VALUE=DATE:20230423
DTEND;VALUE=DATE:20230423
X-MICROSOFT-CDO-ALLDAYEVENT:TRUE
X-MICROSOFT-MSNCALENDAR-ALLDAYEVENT:TRUE
SUMMARY:SkiStar Winter Games Hemsedal
LOCATION:Hemsedal skisenter
DESCRIPTION:SkiStar Winter Games er det åpenbare møtestedet for alle som
elsker alpin utforkjøring. Konkurranser i toppklasse kombineres med akti
viteter som inspirerer til skiglede\, både i og utenfor konkurransearenae
n. SkiStar Winter Games er noe å se frem til – vinterens store skifest.
Her konkurrerer barn og ungdom på en arena som gjøres så lik en verden
scupkonkurranse som mulig\, med storskjerm\, direktesending og partnerby.
ATTACH:https://www.skistar.com/calendar-api/assets/b2/b28a4059-5bfb-4924-9
3fa-081b9d0cfe55/1920x1080wintergamestoppbildhemsedal1.jpg
END:VEVENT
END:VCALENDAR
```
## Run
### As Node service
```bash
npm run start
```
or to override default [Configurations](#configuration), for example
```bash
DESTINATION=Trysil LANGUAGE=English CAL_FILE_NAME=skistar_activities_trysil.ics npm run start
```
### As Docker container
To run a Docker container with Docker Compose (v2):
```bash
docker compose up -d
```
_docker-compose.yml_
```yaml
services:
skistar-activities-ical:
container_name: skistar-activities-ical
image: ismarslomic/skistar-activities-ical:latest
restart: unless-stopped
ports:
- '3001:3001'
# network_mode: "host" # useful if testing on OSX to access container IP from host
environment:
- TZ=Europe/Oslo # setting the timezone for the container OS
- CAL_FILE_NAME=skistar_activities_trysil.ics
- DAYS_IN_FUTURE=3
- DESTINATION=Trysil
- LANGUAGE=English
```
## Configuration
All configuration can be done through environment variables:
| Name | Default | Description |
| ---------------- | ---------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `PORT` | `3001` | The port for Node server serving the iCalendar file |
| `CAL_FILE_NAME` | `skistar_calendar.ics` | The name of the iCalendar file used in the URL |
| `DAYS_IN_FUTURE` | `14` | How many days in the future from now to retrieve Skistar actvities |
| `DESTINATION` | `Hemsedal` | The Skistar destination to retrieve activities for. Valid options are:
- `Hemsedal`
- `Salen`
- `Åre`
- `Vemdalen`
- `Trysil` |
| `LANGUAGE` | `Norsk` | The language used for text in event title and description. Valid options are:
- `English`
- `Norsk`
- `Svenska`
- `Dansk`
- `Deutsch` |
## Contribution
1. Clone the repository
2. Install the dependencies with `npm install`
3. Compile the _TypeScript_ files with `npm run build`
Note! `pre-commit` hook is configured to run _eslint_, _prettier_ and _build_ before committing the changes to git,
see [lint-staged](lint-staged.config.mjs) and [husky pre-commit](.husky/pre-commit) configuration files.
### Linting and formatting
```bash
npm run lint
npm run prettier
```
### Run unit tests locally
```bash
npm run test:unit
```
### Verifying multi-platform Docker build locally
Example using `colima` on Mac OSX
```bash
docker buildx create --use colima
# To support arm/v6 and arm/v7 in colima
docker run --privileged --rm tonistiigi/binfmt --install all
docker buildx build \
--file ./Dockerfile \
--platform linux/amd64,linux/arm/v7,linux/arm64/v8 \
.
```
### Codecov integration in Github actions
Add **Repository secret** in your Github repository with name `CODECOV_TOKEN` and a
secret value from your [codecov.io](https://app.codecov.io/gh) account.