calendar/README.md

77 lines
4.6 KiB
Markdown
Raw Normal View History

2016-09-19 11:04:32 +00:00
# Nextcloud Calendar
2014-04-24 12:10:04 +00:00
2016-09-16 12:17:23 +00:00
[![Build Status](https://travis-ci.org/nextcloud/calendar.svg?branch=master)](https://travis-ci.org/nextcloud/calendar)
[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/nextcloud/calendar/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/nextcloud/calendar/?branch=master)
[![Code Coverage](https://scrutinizer-ci.com/g/nextcloud/calendar/badges/coverage.png?b=master)](https://scrutinizer-ci.com/g/nextcloud/calendar/?branch=master)
[![Coverage Status](https://coveralls.io/repos/github/nextcloud/calendar/badge.svg?branch=master)](https://coveralls.io/github/nextcloud/calendar?branch=master)
2016-09-16 15:58:36 +00:00
[![Dependency Status](https://www.versioneye.com/user/projects/57dc165a037c200040cdced9/badge.svg?style=flat-square)](https://www.versioneye.com/user/projects/57dc165a037c200040cdced9)
2014-08-28 10:46:54 +00:00
2016-09-19 11:04:32 +00: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 13:39:21 +00:00
2016-09-16 08:18:33 +00:00
![](https://github.com/nextcloud/screenshots/raw/master/apps/Calendar/calendar.png)
2015-05-20 13:39:21 +00:00
2016-09-18 19:15:33 +00:00
## Why is this so awesome?
2015-05-20 13:39:21 +00:00
2016-09-18 19:15:33 +00:00
* :rocket: **Integration with other Nextcloud apps!** Currently Contacts more to come.
* :globe_with_meridians: **WebCal Support!** Want to see your favorite team's matchdays in your calendar? No problem!
2016-09-19 09:28:36 +00:00
* :raising_hand: **Attendees!** Invite people to your events.
* :see_no_evil: **Were not reinventing the wheel!** Based on the great [davclient.js](https://github.com/evert/davclient.js), [ical.js](https://github.com/mozilla-comm/ical.js) and [fullcalendar](https://github.com/fullcalendar/fullcalendar) libraries.
2016-09-16 08:14:40 +00:00
2016-09-18 19:15:33 +00:00
And in the works for the [coming versions](https://github.com/nextcloud/calendar/milestones/):
2016-09-19 09:28:36 +00:00
* :mag: Search for events ([#8](https://github.com/nextcloud/calendar/issues/8))
* :alarm_clock: Get alarms for events inside your browser ([#51](https://github.com/nextcloud/calendar/issues/51))
* :watch: See when other attendees are free ([#39](https://github.com/nextcloud/calendar/issues/39))
2015-05-20 13:39:21 +00:00
2016-09-18 19:15:33 +00:00
## Installation
2016-09-16 08:14:40 +00:00
In your Nextcloud, simply navigate to »Apps«, choose the category »Organization«, find the Calendar app and enable it.
2016-09-18 19:15:33 +00:00
Then open the Calendar app from the app menu.
2015-05-20 13:39:21 +00:00
2016-09-19 11:04:32 +00:00
## Support
2015-05-20 13:39:21 +00:00
2016-09-17 00:53:06 +00:00
Check out our [FAQ](https://github.com/nextcloud/calendar/wiki/FAQs). If you dont find a solution, you are welcome to [ask for support](https://help.nextcloud.com) in our Forums or the IRC-Channel. 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 guys at [Nextcloud server](https://github.com/nextcloud/server) for help!
2015-09-05 16:24:28 +00:00
## Supported Browsers
2015-09-05 16:24:28 +00:00
2016-11-22 18:05:33 +00:00
* Chrome/Chromium 49+
* Edge 14+
2016-11-22 18:05:33 +00:00
* Firefox 45+
* Internet Explorer 11
2016-11-22 18:05:33 +00:00
* Safari 10+
2016-03-12 14:45:52 +00:00
We don't support Internet Explorer 10 and below. Patches for IE9+ are accepted though.
2016-09-18 19:15:33 +00:00
## Nightly builds
Testing is a great way to contribute without having to write source code.
Although it's straight forward, setting up the development environment requires some knowledge and extra tools on your device.
We provide [nightly builds](https://nightly.portknox.net/calendar/?C=M;O=D) to enable everyone help testing without setting up the development environment.
1. Download
2. Extract the tar archive to 'path-to-nextcloud/apps'
3. Navigate to »Apps«, choose the category »Productivity«, find the Calendar app and enable it.
The nightly builds are provided by [Portknox.net](https://portknox.net)
When reporting issues, please mention the date in the tar archive's name.
2016-09-19 11:04:32 +00:00
## Maintainers
2016-09-18 19:15:33 +00:00
2016-09-19 11:04:32 +00:00
[Georg Ehrke](https://github.com/georgehrke), [Raghu Nayyar](https://github.com/raghunayyar), [Thomas Citharel](https://github.com/tcitworld) [and many more](https://github.com/nextcloud/calendar/graphs/contributors)
2016-09-18 19:15:33 +00:00
2016-09-18 19:35:26 +00:00
If youd like to join, just go through the [issue list](https://github.com/nextcloud/calendar/issues?q=is%3Aopen+is%3Aissue+label%3A%22starter+issue%22) and fix some. :)
2016-09-18 19:15:33 +00:00
Were also in [#nextcloud-calendar on freenode IRC](https://webchat.freenode.net/?channels=nextcloud-calendar).
2016-10-04 17:24:23 +00:00
Wed like to thank [BrowserStack](https://www.browserstack.com) for providing us with a free subscription.
2016-09-18 19:15:33 +00:00
## Developer setup info
2017-01-18 15:15:30 +00:00
Just clone this repo into your apps directory (Nextcloud server installation needed). Additionally, [nodejs (>=6)](https://nodejs.org/en/download/package-manager/) and [yarn](http://yarnpkg.com) are needed for installing JavaScript dependencies.
2016-09-18 19:15:33 +00:00
Once node and yarn are installed, PHP and JavaScript dependencies can be installed by running
2016-09-18 19:15:33 +00:00
```bash
2016-10-18 11:30:49 +00:00
$ make
2016-09-18 19:15:33 +00:00
```
2016-10-18 11:30:49 +00:00
Please execute this command with your ordinary user account and neither root nor sudo.