Api for creating recurring events based on rules https://recurring-events.martials.no/docs
  • Rust 75.2%
  • Nix 14.8%
  • Just 10%
Find a file
Repository files (latest commit first)
Filename Latest commit message Latest commit date
2026-11-22 10:48:52 +00:00
.cargo refactor-openapi-gen (#21) 2026-08-01 21:44:37 +00:00
.idea feat(Docs): Add initial OpenAPI documentation using utoipa 2026-02-02 20:12:29 +01:00
.nix chore: update repository references for Personal org move (#56) 2026-11-14 10:59:52 +00:00
.woodpecker chore(deps): update alpine docker tag to v3.24.3 (#51) 2026-11-15 09:37:46 +00:00
docs docs: add TechDocs site for recurring-events (#66) 2026-11-22 10:39:05 +00:00
src refactor server.rs 2026-08-22 08:31:41 +00:00
.gitignore docs: add TechDocs site for recurring-events (#66) 2026-11-22 10:39:05 +00:00
AGENTS.md refactor server.rs 2026-08-22 08:31:41 +00:00
Cargo.lock fix(deps): update dependencies (non-major) (#64) 2026-11-21 23:49:38 +00:00
Cargo.toml fix(deps): update dependencies (non-major) (#64) 2026-11-21 23:49:38 +00:00
catalog-info.yaml fix(catalog): point TechDocs at the default branch (#67) 2026-11-22 10:48:52 +00:00
CODEOWNERS Migration: codeowners (#55) 2026-10-28 19:40:52 +00:00
flake.lock chore(deps): lock file maintenance (#40) 2026-10-27 10:44:29 +00:00
flake.nix docs: add TechDocs site for recurring-events (#66) 2026-11-22 10:39:05 +00:00
Justfile docs: add TechDocs site for recurring-events (#66) 2026-11-22 10:39:05 +00:00
LICENSE contract-first (#15) 2026-07-02 15:36:20 +00:00
mkdocs.yml docs: add TechDocs site for recurring-events (#66) 2026-11-22 10:39:05 +00:00
openapi-to-rust.toml feat: Replace openapi-generator with openapi-to-rust (#22) 2026-08-08 07:08:34 +00:00
openapi.yaml fix: Failing test 2026-08-08 11:32:51 +02:00
README.md fix(catalog): point TechDocs at the default branch (#67) 2026-11-22 10:48:52 +00:00
renovate.json Migration: renovate-config (#54) 2026-10-25 17:59:19 +00:00
treefmt.nix feat: Replace openapi-generator with openapi-to-rust (#22) 2026-08-08 07:08:34 +00:00

Recurring Events

Axum API for generating recurring calendar events as JSON or iCalendar.

Development

Prerequisites:

  • Cargo
  • openapi-to-rust CLI
  • Nix (for building image)

A development environment is provided by the Nix flake.

nix develop

Generate server code from OpenAPI contract:

First make sure you have openapi-to-rust installed.

cargo install openapi-to-rust
just generate

Run tests:

just test

Run the server:

Runs on 0.0.0.0:8000. Swagger UI is available at /docs.

just run

Build with nix build or just build.

Documentation

The TechDocs source is in docs/, with navigation in mkdocs.yml. After entering nix develop, build it with just docs or preview it at http://127.0.0.1:8001 with just docs-serve. Add pages under docs/ and add them to the nav list in mkdocs.yml.

The root catalog-info.yaml points the recurring-events Component at this repository's documentation with a backstage.io/techdocs-ref URL. The URL includes the default branch because Backstage's Gitea reader needs a ref to download the repository tree; update it if the default branch changes. After the descriptor and docs are on the default branch, open the Component in Backstage and select its TechDocs tab. The local Backstage TechDocs backend uses its configured Docker generator; check backend logs and Docker availability if the page does not build. API documentation is also served by the service at https://recurring-events.martials.no/docs.

Do not put credentials or private values in documentation. For a hosted portal, the TechDocs deployment and access-control approach is tracked in Personal/backstage#25; do not expose generated private docs from a public bucket.

License

MIT