Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/fmeringdal/nettu-scheduler
A self-hosted calendar and scheduler server.
https://github.com/fmeringdal/nettu-scheduler
calendars rrule rust scheduler self-hosted
Last synced: 6 days ago
JSON representation
A self-hosted calendar and scheduler server.
- Host: GitHub
- URL: https://github.com/fmeringdal/nettu-scheduler
- Owner: fmeringdal
- License: mit
- Created: 2020-12-26T23:57:31.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2022-06-10T17:03:04.000Z (over 2 years ago)
- Last Synced: 2024-08-01T15:36:29.940Z (3 months ago)
- Topics: calendars, rrule, rust, scheduler, self-hosted
- Language: Rust
- Homepage:
- Size: 2.3 MB
- Stars: 535
- Watchers: 16
- Forks: 27
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Nettu scheduler
[](LICENSE)
[](https://github.com/fmeringdal/nettu-scheduler/actions/workflows/release.yml)
[](https://codecov.io/gh/fmeringdal/nettu-scheduler)
## Overview
`Nettu scheduler` is a self-hosted calendar and scheduler server that aims to provide the building blocks for building calendar / booking apps with ease. It has a simple REST API and also a [JavaScript SDK](https://www.npmjs.com/package/@nettu/sdk-scheduler) and [Rust SDK](https://crates.io/crates/nettu_scheduler_sdk).
It supports authentication through api keys for server - server communication and JSON Web Tokens for browser - server communication.
## Features
- **Booking**: Create a `Service` and register `User`s on it to make them bookable.
- **Calendar Events**: Supports recurrence rules, flexible querying and reminders.
- **Calendars**: For grouping `Calendar Event`s.
- **Freebusy**: Find out when `User`s are free and when they are busy.
- **Integrations**: Connect your Nettu, Google and Outlook calendars
- **Multi-tenancy**: All resources are grouped by `Account`s.
- **Metadata queries**: Add key-value metadata to your resources and then query on that metadata
- **Webhooks**: Notifying your server about `Calendar Event` reminders.
## Quick start
The server is using PostgreSQL for persistence, so we will need to spin up that first:
```bash
cd scheduler
docker-compose -f integrations/docker-compose.yml up -d
```
Now we are ready to start the `nettu-scheduler` server with `cargo`
```bash
cd scheduler
export ACCOUNT_API_KEY="REPLACE_ME"
export DATABASE_URL="postgresql://postgres:postgres@localhost:5432/nettuscheduler"
export PORT="3000"
cargo run
```
The `ACCOUNT_API_KEY` environment variable is going to create an `Account` (if it does not already exist) during
server startup with the given key. `Account`s act as tenants in the server, and it is possible to create multiple `Account`s by using the `CREATE_ACCOUNT_SECRET_CODE` which you can provide as an environment variable.
Quick example of how to create and query a user
```bash
export SECRET_API_KEY="REPLACE ME WITH YOUR API KEY"
# Create a user with metadata
curl -X POST -H "Content-Type: application/json" -H "x-api-key: $SECRET_API_KEY" -d '{"metadata": { "groupId": "123" }}' http://localhost:5000/api/v1/user
# Get users by metadata
curl -H "x-api-key: $SECRET_API_KEY" "http://localhost:5000/api/v1/user/meta?key=groupId&value=123"
```
Please see below for links to more examples.
## Examples
- [Calendars and Events](examples/calendar-events.md)
- [Booking](examples/booking.md)
- [Reminders](examples/reminders.md)
- [Creating JWT for end-users](examples/jwt.md)
## Contributing
Contributions are welcome and are greatly appreciated!
## License
[MIT](LICENSE)
## Special thanks
- [Lemmy](https://github.com/LemmyNet/lemmy) for inspiration on how to use cargo workspace to organize a web app in rust.
- [The author of this blog post](https://www.lpalmieri.com/posts/2020-09-27-zero-to-production-4-are-we-observable-yet/) for an excellent introduction on how to do telemetry in rust.