Central documentation for the cleanURI service.
The system consists of the following sub-projects:
- Site - Interfaces and helpers for site-specific implementations
- Site Implementations - Sites supported by the cleanURI project
- Common - Common classes and definitions
- API Gateway - REST API Gateway to the backend services
- Canonizer - Transform a URL into its canonic form
- Extractor - Extract meta-data to create decorated referencess
- 🚧 Cache
- Web UI - A web-based frontend
- Helm Chart
- Stefan Haun (@penguineer)
PRs are welcome!
If possible, please stick to the following guidelines:
- Keep PRs reasonably small and their scope limited to a feature or module within the code.
- If a large change is planned, it is best to open a feature request issue first, then link subsequent PRs to this issue, so that the PRs move the code towards the intended feature.
Please check the sub-projects linked above to see where the contribution would fit best.
MIT © 2022 Stefan Haun and contributors