caldav-client

commit

4f3886c613857fcd7aacddfda6c894c3baf9f2f5

parent

7409142797a1d8704983c2b168c271ddb022ebc6

Author

Tobias Bengfort <tobias.bengfort@posteo.de>

Date

2022-02-04 17:02

add README

Diffstat

2 files changed, 35 insertions, 0 deletions

diff --git a/README.md b/README.md

@@ -0,0 +1,34 @@
   -1     1 This is a standalone CalDAV web client. It is based on [fullcalendar][0] and
   -1     2 [ical.js][1] and inspired by [CalDavZAP][2].
   -1     3 
   -1     4 # installation
   -1     5 
   -1     6 Run `npm install` and then copy everything (including the `node_modules`
   -1     7 folder) to a server. You also need to set `rootUrl` in config.js to the URL of
   -1     8 the principal who's calendars should be displayed. It must be on the same
   -1     9 origin.
   -1    10 
   -1    11 Note that this is only a client. You will also need a CalDAV server, e.g.
   -1    12 [baikal][3] or [radicale][4].
   -1    13 
   -1    14 # architecture
   -1    15 
   -1    16 We have to work with two different structures: The one defined by CalDAV and
   -1    17 the other one defined by fullcalendar.
   -1    18 
   -1    19 In CalDAV there are calendars and events. In fullcalendar there are event
   -1    20 sources and events.
   -1    21 
   -1    22 Each CalDAV calendar maps to a fullcalendar event source. `source.id` is the
   -1    23 URL of the CalDAV calendar.
   -1    24 
   -1    25 Each CalDAV event maps to one or (for recurring events) more fullcalendar
   -1    26 events. `event.groupId` is the URL of the CalDAV event.
   -1    27 `event.extendedProps.comp` is the parsed ICS. `event.extendedProps.offset` is
   -1    28 the offset in seconds from the first instance to this one.
   -1    29 
   -1    30 [0]: https://fullcalendar.io/
   -1    31 [1]: https://github.com/mozilla-comm/ical.js
   -1    32 [2]: https://inf-it.com/open-source/clients/caldavzap/
   -1    33 [3]: https://sabre.io/baikal/
   -1    34 [4]: https://radicale.org/

diff --git a/config.js b/config.js

@@ -0,0 +1 @@
   -1     1 export var rootUrl = '/path/to/principal/';