{"id":13580436,"url":"https://github.com/fmeringdal/nettu-scheduler","last_synced_at":"2025-04-05T06:06:02.936Z","repository":{"id":38081032,"uuid":"324655552","full_name":"fmeringdal/nettu-scheduler","owner":"fmeringdal","description":"A self-hosted calendar and scheduler server. ","archived":false,"fork":false,"pushed_at":"2022-06-10T17:03:04.000Z","size":2410,"stargazers_count":546,"open_issues_count":6,"forks_count":26,"subscribers_count":16,"default_branch":"master","last_synced_at":"2025-03-29T05:04:54.280Z","etag":null,"topics":["calendars","rrule","rust","scheduler","self-hosted"],"latest_commit_sha":null,"homepage":"","language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/fmeringdal.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-12-26T23:57:31.000Z","updated_at":"2025-02-17T11:43:33.000Z","dependencies_parsed_at":"2022-08-31T02:20:29.043Z","dependency_job_id":null,"html_url":"https://github.com/fmeringdal/nettu-scheduler","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fmeringdal%2Fnettu-scheduler","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fmeringdal%2Fnettu-scheduler/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fmeringdal%2Fnettu-scheduler/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fmeringdal%2Fnettu-scheduler/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/fmeringdal","download_url":"https://codeload.github.com/fmeringdal/nettu-scheduler/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247294537,"owners_count":20915340,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["calendars","rrule","rust","scheduler","self-hosted"],"created_at":"2024-08-01T15:01:51.360Z","updated_at":"2025-04-05T06:06:02.916Z","avatar_url":"https://github.com/fmeringdal.png","language":"Rust","funding_links":[],"categories":["Rust"],"sub_categories":[],"readme":"\u003cdiv align=\"center\"\u003e\n\u003cimg width=\"400\" src=\"docs/logo.png\" alt=\"logo\"\u003e\n\u003c/div\u003e\n\n# Nettu scheduler\n\n[![MIT licensed](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE)\n[![Release](https://github.com/fmeringdal/nettu-scheduler/actions/workflows/release.yml/badge.svg)](https://github.com/fmeringdal/nettu-scheduler/actions/workflows/release.yml)\n[![codecov](https://codecov.io/gh/fmeringdal/nettu-scheduler/branch/master/graph/badge.svg?token=l5z2mzzdHu)](https://codecov.io/gh/fmeringdal/nettu-scheduler)\n\n## Overview\n\n`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).\n\nIt supports authentication through api keys for server - server communication and JSON Web Tokens for browser - server communication.\n\n## Features\n\n- **Booking**: Create a `Service` and register `User`s on it to make them bookable.\n- **Calendar Events**: Supports recurrence rules, flexible querying and reminders.\n- **Calendars**: For grouping `Calendar Event`s.\n- **Freebusy**: Find out when `User`s are free and when they are busy.\n- **Integrations**: Connect your Nettu, Google and Outlook calendars\n- **Multi-tenancy**: All resources are grouped by `Account`s.\n- **Metadata queries**: Add key-value metadata to your resources and then query on that metadata\n- **Webhooks**: Notifying your server about `Calendar Event` reminders.\n\n\u003cbr/\u003e\n\n\u003cdiv align=\"center\"\u003e\n\u003cimg src=\"docs/flow.svg\" alt=\"Application flow\"\u003e\n\u003c/div\u003e\n\n## Quick start\n\nThe server is using PostgreSQL for persistence, so we will need to spin up that first:\n\n```bash\ncd scheduler\ndocker-compose -f integrations/docker-compose.yml up -d\n```\n\nNow we are ready to start the `nettu-scheduler` server with `cargo`\n\n```bash\ncd scheduler\nexport ACCOUNT_API_KEY=\"REPLACE_ME\"\nexport DATABASE_URL=\"postgresql://postgres:postgres@localhost:5432/nettuscheduler\"\nexport PORT=\"3000\"\ncargo run\n```\n\nThe `ACCOUNT_API_KEY` environment variable is going to create an `Account` (if it does not already exist) during\nserver 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.\n\nQuick example of how to create and query a user\n\n```bash\nexport SECRET_API_KEY=\"REPLACE ME WITH YOUR API KEY\"\n\n# Create a user with metadata\ncurl -X POST -H \"Content-Type: application/json\" -H \"x-api-key: $SECRET_API_KEY\" -d '{\"metadata\": { \"groupId\": \"123\" }}' http://localhost:5000/api/v1/user\n\n# Get users by metadata\ncurl -H \"x-api-key: $SECRET_API_KEY\" \"http://localhost:5000/api/v1/user/meta?key=groupId\u0026value=123\"\n```\n\nPlease see below for links to more examples.\n\n## Examples\n\n- [Calendars and Events](examples/calendar-events.md)\n\n- [Booking](examples/booking.md)\n\n- [Reminders](examples/reminders.md)\n\n- [Creating JWT for end-users](examples/jwt.md)\n\n## Contributing\n\nContributions are welcome and are greatly appreciated!\n\n## License\n\n[MIT](LICENSE)\n\n## Special thanks\n\n- [Lemmy](https://github.com/LemmyNet/lemmy) for inspiration on how to use cargo workspace to organize a web app in rust.\n- [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.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffmeringdal%2Fnettu-scheduler","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffmeringdal%2Fnettu-scheduler","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffmeringdal%2Fnettu-scheduler/lists"}