Skip to content

Latest commit

 

History

History
193 lines (161 loc) · 8.33 KB

README.md

File metadata and controls

193 lines (161 loc) · 8.33 KB

Logo

Kalle - The CalDav Scheduling Tool

Overview

Kalle is an appointment scheduling tool that allows you to schedule an appointment with customers, colleagues or friends within seconds. We support self-hosted CalDav-based calendars and solutions such as authenticating your Google calendar or Outlook calendar.

Kalle is a modern web app that is built with Blitz.js, a full-stack React framework, made to boost productivity. A hosted version can be found at kalle.app.

This Project is part of the "Trends und Konzepte dynamischer Web-Anwendungen" Project Seminar 2020/21 at the Hasso-Plattner-Institute.

Features

Feature
Create an account
📆 Connect CalDav calendars
📆 Connect Google calendars
📆 Connect Outlook calendars
🤝 Create a meeting
📲 Book an appointment
Cancel an appointment
Use schedule presets
🗓 📆 Use multiple calendars
🔎 Compare invitee`s calendar
✉️ Email confirmations and reminders
👩🏻‍🎨 Select for each meeting a calendar where to book your appointments

Testimonials

Kalle is a godsend tool that treated my eczema in a matter of days. Looking forward to bikini season!
~ Natalia Woroniec

Getting Started

Setup

Follow these steps for a development environment:

Make sure you have installed Docker on your system and set the appropriate permissions. Then run the following command:

npm install

Now you have to create a .env.local file in your root folder.

This should contain the following properties:

DATABASE_URL="postgres://user:password@hostname:port/database"
EMAIL_FROM="[email protected]"
SMTP_USER="Insert SMTP username"
SMTP_PASSWORD="Insert SMTP password"
SMTP_PORT="Insert the PORT of the SMTP server, usually 587"
SMTP_HOST="Insert the HOSTNAME of the SMTP server"
MODE="DEVELOPMENT"
HOME_URL="URL where kalle is deployed from: http://localhost:3000"
GOOGLE_CLIENT_ID="OAuth token to use Google calendars"
GOOGLE_CLIENT_SECRET="OAuth token to use Google calendars"
MICROSOFT_CLIENT_SECRET="OAuth token to use Outlook calendars"
MICROSOFT_CLIENT_ID="OAuth token to use Outlook calendars"

When mode !== development mails will be sent!

Running the Application

Running npm run dev will start up a server which can be reached over the specified URL :) It will also start up the PostgreSQL database, a Baikal server containing a calendar for experimental purposes, a Nextcloud server, the Quirrel job queue and Mailhog.

Using Google Calendar and Outlook Calendar

We provide an interface to different calendar providers via OAuth 2.0. If you want to host your own Kalle instance and use one of the calendar providers, you will have to set some environment variables:

  1. Google Calendar: You have to get a CLIENT_ID and a CLIENT_SECRET. For that you can start here. Save these values in the in environment variables GOOGLE_CLIENT_ID and GOOGLE_CLIENT_SECRET.
  2. Microsoft Outlook: This works similar to Google Calendar. You have to get a CLIENT_ID and a CLIENT_SECRET (see here). Write these values in the MICROSOFT_CLIENT_ID and MICROSOFT_CLIENT_SECRET environment variables.

Furthermore add the environment variable HOME_URL which is the base URL of your Kalle instance (e.g. https://kalle.app)

Contributors ✨

Thanks goes to these wonderful people (emoji key):


Rohan Sawahn

💻 🤔

Lukas Laskowski

💻 🤔

Philip Weidenfeller

💻 🤔

Stefan Spangenberg

💻 🤔

Simon Knott

💻 🤔

Patrick Connolly

🖋

This project follows the all-contributors specification. Contributions of any kind welcome!