https://github.com/cxwudi/youcal

Inspired by YouTrack Due Day Calendar, export YouTrack Issue Due to other calendar services (through iCalendar)
https://github.com/cxwudi/youcal

ical youtrack-api

Last synced: 20 days ago
JSON representation

Inspired by YouTrack Due Day Calendar, export YouTrack Issue Due to other calendar services (through iCalendar)

• Host: GitHub
• URL: https://github.com/cxwudi/youcal
• Owner: CXwudi
• License: mit
• Created: 2022-10-23T00:52:40.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2024-12-12T18:13:55.000Z (22 days ago)
• Last Synced: 2024-12-12T19:23:43.529Z (22 days ago)
• Topics: ical, youtrack-api
• Language: Kotlin
• Homepage:
• Size: 4.03 MB
• Stars: 3
• Watchers: 2
• Forks: 0
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# YouCal

YouTrack + iCal = YouCal

Inspired by YouTrack Due Day Calendar, export YouTrack Issue Due to iCal so that other calendar services can subscribe

through iCalendar, using [iCal4j](https://github.com/ical4j/ical4j) library.

![showcase](doc/showcase.png)

This repo is also the remastered version of the original [youcal](https://github.com/sshipway/youcal) (which is no

longer working for me)

For JetBrains Staffs: If you want to reuse some part of this code, just make sure you credit a link to this repo in your

own repo

This is open-source project, so feel free to fork this repo and modify it in any way you like. 🙂

## Common Prerequisites

- Java 21

    - Optionally GraalVM with `native-image` installed

## Documentation

Click on each module for more information:

Application modules:

- [yc-app-cli](yc-app-cli/README.md): The CLI application to export YouTrack Issues from a search query to .ics file.

Library modules:

- [yc-apiclient-youtrack](yc-apiclient-youtrack): The YouTrack API Client written in Spring declarative HTTP client

  coming from Spring 6

- [yc-core-ical](yc-core-ical): The core processing iCal module, can transform one YouTrack Issue into

  one [`VEvent`](https://icalendar.org/iCalendar-RFC-5545/3-6-1-event-component.html),

  using [iCal4j](https://github.com/ical4j/ical4j) library

## Current Progress

- [x] design

- [x] minimal development

- [x] documentation (only for the CLI app)

- [ ] further development

    - So far, this app only supports mapping an YouTrack issue with one date-time/date field into a one-day

      event ([`VEvent`](https://icalendar.org/iCalendar-RFC-5545/3-6-1-event-component.html) with a `DATE` value type

      of `DTSTART` property, and no `DTEND` or `DURATION` property) in icalendar.

      However, a new design at [#7](https://github.com/CXwudi/youcal/issues/7) has been proposed to support more complex mapping,

      and if more people are interested in this project, I will implement it.