From 57f9ba84273d95d2a907114ec1520a11f334baab Mon Sep 17 00:00:00 2001 From: Benoit TELLIER Date: Mon, 12 May 2025 13:29:39 +0200 Subject: [PATCH] [DOCUMENTATION] Init the README --- README.md | 42 ++++++++++++++++++++++++++++++++++++++++-- assets/calendar.svg | 23 +++++++++++++++++++++++ 2 files changed, 63 insertions(+), 2 deletions(-) create mode 100644 assets/calendar.svg diff --git a/README.md b/README.md index c9f8125..bf5a64f 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,40 @@ -# twake-calendar-frontend -Fonctend for Twake Calendar +# Twake Calendar Frontend + +![LOGO](assets/calendar.svg) + +## Goals + +This project aims at service a Single Page Application allowing a user to interact with its calendar. + +This frontend-only application will interact with: + + - [esn-sabre](https://github.com/linagora/esn-sabre/) CalDAV + CardDAV server, tailor made for LINAGORA needs. + - [Twake Calendar side service](https://github.com/linagora/twake-calendar-side-service) that delivers additional backend features for Sabre. + +It is meant as a drop in replacement of [esn-frontend-calendar](https://github.com/linagora/esn-frontend-calendar). + +## Running it + +### Compile it and run it + +More details to be supplied when available. + +### Run it with docker + +More details to be supplied when available. + +## Configuring it + +More details to be supplied when available. + +## Roadmap + +The Minimum Viable Product involves all features currently used in production for **esn-frontend-calendar**. + +It includes basic calendaring features and shared / delegated calendar capacity. + +After completing the MVP which should be done ~Q1 2026 we will work on additional integrations (viso, drive), resources, tasks, and much more exciting features. + +## Credits + +Developed with <3 at [LINAGORA](https://linagora.com) ! diff --git a/assets/calendar.svg b/assets/calendar.svg new file mode 100644 index 0000000..5f8725b --- /dev/null +++ b/assets/calendar.svg @@ -0,0 +1,23 @@ + + + + + + + + + + + + + + + + + + + + + + +