Contributing

Suggestions, requests and ideas

If you have a suggestion or idea that could make this website better, or if you want to request a new language to be added, please feel free to send me an email at [email protected].

Adding a new language

You can send me a patch implementing support for your language. Take a look at the codebase. I think everything is pretty self-explanatory. You should create a new implementation of the WordDefinitionRepository and WordTranslationRepository interfaces and add it to the corresponding composite classes.

The patches should be sent over email with the subject [larousseapi] PATCH: description

For alignment on anything, you can contact me over email or message me on LinkedIn. I will gladly discuss the API's design and other technical stuff in a call or text.

Technical stack

The API uses Quarkus REST for the API and the Qute template engine for the frontend. Everything is deployed on k8s and instrumented for both frontend and backend metrics with Umami and OTEL respectively. Once you clone the repository, you should be able to run it in dev mode with quarkus dev.

There are no external databases or else needed, for now. I plan to add a caching layer in the future.