- Rust 75.2%
- Nix 14.8%
- Just 10%
| Filename | Latest commit message | Latest commit date |
|---|---|---|
| .cargo | ||
| .idea | ||
| .nix | ||
| .woodpecker | ||
| docs | ||
| src | ||
| .gitignore | ||
| AGENTS.md | ||
| Cargo.lock | ||
| Cargo.toml | ||
| catalog-info.yaml | ||
| CODEOWNERS | ||
| flake.lock | ||
| flake.nix | ||
| Justfile | ||
| LICENSE | ||
| mkdocs.yml | ||
| openapi-to-rust.toml | ||
| openapi.yaml | ||
| README.md | ||
| renovate.json | ||
| treefmt.nix | ||
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.