https://github.com/nextcloud/calendar-js

Small library that wraps ICAL.js and provides more convenient means for editing
https://github.com/nextcloud/calendar-js

icalendar icaljs library rfc5545 rfc7986

Last synced: about 1 month ago
JSON representation

Small library that wraps ICAL.js and provides more convenient means for editing

• Host: GitHub
• URL: https://github.com/nextcloud/calendar-js
• Owner: nextcloud
• License: agpl-3.0
• Created: 2019-05-20T17:17:39.000Z (over 5 years ago)
• Default Branch: main
• Last Pushed: 2024-09-24T04:54:16.000Z (about 2 months ago)
• Last Synced: 2024-09-30T02:41:02.045Z (about 2 months ago)
• Topics: icalendar, icaljs, library, rfc5545, rfc7986
• Language: JavaScript
• Homepage: https://www.npmjs.com/package/@nextcloud/calendar-js
• Size: 4.49 MB
• Stars: 14
• Watchers: 4
• Forks: 8
• Open Issues: 8
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

        
# :date: @nextcloud/calendar-js - Heart of the [Nextcloud calendar app](https://github.com/nextcloud/calendar)

[![npm](https://img.shields.io/npm/v/%40nextcloud%2Fcalendar-js?style=flat-square)](https://www.npmjs.com/package/@nextcloud/calendar-js) [![Build statis](https://img.shields.io/github/actions/workflow/status/nextcloud/nextcloud-calendar-js/node-test.yml?style=flat-square)](https://github.com/nextcloud/calendar-js/actions/workflows/node-test.yml) [![Codecov branch](https://img.shields.io/codecov/c/gh/nextcloud/calendar-js/main?style=flat-square)](https://codecov.io/gh/nextcloud/calendar-js) 

This library is a wrapper for [ICAL.js](https://github.com/mozilla-comm/ical.js/) that provides more convenient ways for editing.

Together with [cdav-library](https://github.com/nextcloud/cdav-library), it's the heart of the Nextcloud calendar app.

## Maintainers

* [@ChristophWurst](https://github.com/ChristophWurst)

* [@GretaD](https://github.com/GretaD)

* [@st3iny](https://github.com/st3iny)

* [@GVodyanov](https://github.com/GVodyanov)

## Developing

Please take note that this library has been developed solely for the purpose of using it in the Nextcloud calendar app.

Feel free to use it in your project, but don't expect any support / bugfixes / features.

### Setup

```bash

npm ci

```

### Tests

```bash

npm run test

```

### Linting

```bash

npm run lint

```

## Releases

This repository follows the concept of [conventional commits](https://www.conventionalcommits.org/en/v1.0.0). A github action workflow automates the release. However, an authorized [maintainer](#maintainers) has to approve the workflow before it can run.

1) Go to https://github.com/nextcloud/calendar-js/actions/workflows/release.yml

2) Click *Run workflow*

   1) Select *Branch: main*

   2) Click *Run workflow*

3) Reload the page

4) Click on the waiting *Release* workflow (yellow clock icon) and approve it if you have permission or ask one of the [maintainers](#maintainers)

## License

Calendar-js is licensed under the [GNU Affero General Public License](https://www.gnu.org/licenses/agpl-3.0.en.html), version 3 or later.