From: Alexander Goussas Date: Sun, 31 May 2026 18:03:31 +0000 (-0500) Subject: feat: add about and contributing sections X-Git-Url: http://git.frustrated-labs.net/?a=commitdiff_plain;h=596fcd993acd1ba8aee368127eb898d102dd3603;p=larousseapi feat: add about and contributing sections --- diff --git a/src/main/resources/templates/pub/about.html b/src/main/resources/templates/pub/about.html new file mode 100644 index 0000000..6b12938 --- /dev/null +++ b/src/main/resources/templates/pub/about.html @@ -0,0 +1,69 @@ +{@net.frustratedfunctor.ui.WordTranslationsDefinitions translationsDefinitions} + + + + +Frustrated Langs | About + + + + + + + + + + +
+ +
+ +
+

About

+

+ I started building this site mainly to learn Quarkus and Kubernetes. + Nonetheless, I have found it useful, specially the API, for my language learning purposes. + As such, I will continue to develop and maintain it for the foreseeable future. +

+

+ You can use the search bar to get translations and definitions for words. For now, we only + support French to English translations, but support for other languages is planned for the + near future. +

+

+ If you think you can make this site better, or if you want a new language to be added, + see the contributing section. +

+
+ + + + + \ No newline at end of file diff --git a/src/main/resources/templates/pub/contributing.html b/src/main/resources/templates/pub/contributing.html new file mode 100644 index 0000000..78b98b3 --- /dev/null +++ b/src/main/resources/templates/pub/contributing.html @@ -0,0 +1,87 @@ +{@net.frustratedfunctor.ui.WordTranslationsDefinitions translationsDefinitions} + + + + +Frustrated Langs | Contributing + + + + + + + + + + +
+ +
+ +
+

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 goussasalexander@gmail.com. +

+

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. +

+
+ + + + + \ No newline at end of file diff --git a/src/main/resources/templates/pub/index.html b/src/main/resources/templates/pub/index.html index e3a5cba..34bcd6f 100644 --- a/src/main/resources/templates/pub/index.html +++ b/src/main/resources/templates/pub/index.html @@ -34,9 +34,9 @@