feat: init

This commit is contained in:
2025-09-29 11:18:52 +02:00
commit 363642d050

25
README.md Normal file
View File

@ -0,0 +1,25 @@
# almanac
## Issues
* The recipe catalogue is big and getting bigger. Cloning it locally when
running the first commands with `abra` is now becoming *super* slow. Parsing
versions and doing on-the-fly catalogue operations in `abra` is getting
slower, and slower.
* It would be better if `abra` didn't even have catalogue management
functionality and simply was a "catalogue client" and not also producer. This
reduces the scope of `abra` further which has benefits.
* We need less manual work and more automation to support us so that our
project remains sustainable as it scales out horizontally (more collectives,
more recipes, more activity). It would be simpler to have automation which
doesn't rely on a [relatively complex CI/CD
setup](https://git.coopcloud.tech/toolshed/organising/issues/604#issuecomment-20279).
## Prototype
* Single binary GUI-less web API instead of a monolithic Git repository ([`#604`](https://git.coopcloud.tech/toolshed/organising/issues/604)).
* Minimal configuration: point it at a Gitea organsation and you're done.
* Webhook API for on-demand catalogue generation.
* Background scheduler for periodic catalogue generation.
* Optimized recipe API for `abra` queries (auto-completion, recipe versions, etc.).
* Re-use the `abra catalogue sync` command to maintain `--offline` support.