nextcloud-calendar/README.md

82 lines
3.8 KiB
Markdown
Raw Permalink Normal View History

2016-09-19 13:04:32 +02:00
# Nextcloud Calendar
2014-04-24 14:10:04 +02:00
![GitHub Workflow Status](https://img.shields.io/github/workflow/status/nextcloud/calendar/Build)
![Codecov](https://img.shields.io/codecov/c/github/nextcloud/calendar)
2014-08-28 12:46:54 +02:00
2016-09-19 13:04:32 +02:00
**A calendar app for [Nextcloud](http://nextcloud.com). Easily sync events from various devices with your Nextcloud and edit them online.**
2015-05-20 15:39:21 +02:00
![](https://raw.githubusercontent.com/nextcloud/screenshots/master/apps/Calendar/calendar_application.png)
2015-05-20 15:39:21 +02:00
## :blue_heart: :tada: Why is this so awesome?
2015-05-20 15:39:21 +02:00
* :rocket: **Integration with other Nextcloud apps!** Like Contacts, Talk, Tasks, Deck and Circles
2016-09-18 21:15:33 +02:00
* :globe_with_meridians: **WebCal Support!** Want to see your favorite team's matchdays in your calendar? No problem!
* :raising_hand: **Attendees!** Invite people to your events
* :watch: **Free/Busy!** See when your attendees are available to meet
* :alarm_clock: **Reminders!** Get alarms for events inside your browser and via email
* :mag: **Search!** Find your events at ease
* :ballot_box_with_check: **Tasks!** See tasks or Deck cards with a due date directly in the calendar
* :speaker: **Talk rooms!** Create an associated Talk room when booking a meeting with just one click
* :calendar: **Appointment booking** Send people a link so they can book an appointment with you [using this app](https://apps.nextcloud.com/apps/appointments)
* :see_no_evil: **Were not reinventing the wheel!** Based on the great [c-dav library](https://github.com/nextcloud/cdav-library), [ical.js](https://github.com/mozilla-comm/ical.js) and [fullcalendar](https://github.com/fullcalendar/fullcalendar) libraries.
2016-09-16 10:14:40 +02:00
2015-05-20 15:39:21 +02:00
## :hammer_and_wrench: Installation
2016-09-16 10:14:40 +02:00
The app is distributed through the [app store](https://apps.nextcloud.com/apps/calendar) and you can install it [right from your Nextcloud installation](https://docs.nextcloud.com/server/stable/admin_manual/apps_management.html).
Release tarballs are hosted at https://github.com/nextcloud-releases/calendar/releases.
2015-05-20 15:39:21 +02:00
## :satellite: Support
2015-05-20 15:39:21 +02:00
If you need assistance or want to ask a question about Calendar, you are welcome to [ask for support](https://help.nextcloud.com/c/apps/calendar) in our Forums.
If you have found a bug, feel free to open a new Issue on GitHub. Keep in mind, that this repository only manages the frontend.
If you find bugs or have problems with the CalDAV-Backend, you should ask the team at [Nextcloud server](https://github.com/nextcloud/server) for help!
2015-09-05 18:24:28 +02:00
## :earth_africa: Supported Browsers
2015-09-05 18:24:28 +02:00
* Chrome/Chromium 76+
* Edge 40+
* Firefox 60+
* Internet Explorer 11
* Safari 12.1+
2016-03-12 15:45:52 +01:00
## Maintainers
* [Nextcloud Groupware team](https://github.com/nextcloud/groupware/#members)
## Build the app
2016-09-18 21:15:33 +02:00
To build you will need to have [Node.js](https://nodejs.org/en/) and
[Composer](https://getcomposer.org/) installed.
2016-09-18 21:15:33 +02:00
- Install PHP dependencies: `composer install`
- Install JS dependencies: `npm ci`
- Build JavaScript for the frontend
- `npm run dev` development build
- `npm run watch` watch for changes
- `npm run build` production build
2016-09-18 21:15:33 +02:00
Read more about [necessary prerequisites](https://docs.nextcloud.com/server/latest/admin_manual/installation/source_installation.html#prerequisites-for-manual-installation) for manual installs.
2016-10-04 19:24:23 +02:00
## Running tests
You can run the following back-end and front-end tests by using:
2016-09-18 21:15:33 +02:00
```
composer test
npm run test
```
## :v: Code of conduct
The Nextcloud community has core values that are shared between all members during conferences,
hackweeks and on all interactions in online platforms including [Github](https://github.com/nextcloud) and [Forums](https://help.nextcloud.com).
If you contribute, participate or interact with this community, please respect [our shared values](https://nextcloud.com/code-of-conduct/). :relieved:
## :heart: How to create a pull request
This guide will help you get started:
- :dancer: :smile: [Opening a pull request](https://opensource.guide/how-to-contribute/#opening-a-pull-request)