diff --git a/README.md b/README.md index 7207d6a..c16629d 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,22 @@ -# ffsaf-site +# FFSAF - Intranet -This project uses Quarkus, the Supersonic Subatomic Java Framework. +## Introduction et context -If you want to learn more about Quarkus, please visit its website: https://quarkus.io/ . +L’intranet de la Fédération française de Soft Armored Fighting a pour but centralise la prise de licences des adhérents +et l’affiliation des clubs. Il permet aussi de recueillir les résultats des compétitions organisées par les clubs et, +plus récemment, d’en faciliter l’organisation grâce à un outil intégré. + +Le système de prise de licence se divise en trois parties : + +* Un formulaire public pour la première demande d’affiliation ; +* Un espace club, accessible après validation, pour la saisie des informations relatives aux demandes de licence des + adhérents ; +* Un espace fédération pour accepter les demandes de licences et d’affiliation. + Un espace membre permet enfin à chaque adhérent de télécharger son attestation de licence. + +Pour les compétitions, le système permet la création de catégories, de poules et de matchs, avec génération automatique +des matchs au sein d’une poule. Il supporte plusieurs lices, assure la synchronisation en temps réel des modifications +entre toutes les instances de l’application web et publie automatiquement les résultats sur le site de l’organisateur. ## Running the application in dev mode @@ -51,35 +65,4 @@ Or, if you don't have GraalVM installed, you can run the native executable build You can then execute your native executable with: `./target/ffsaf-site-1.0-SNAPSHOT-runner` -If you want to learn more about building native executables, please consult https://quarkus.io/guides/maven-tooling. - -## Related Guides - -- Reactive MySQL client ([guide](https://quarkus.io/guides/reactive-sql-clients)): Connect to the MySQL database using the reactive pattern -- RESTEasy Reactive ([guide](https://quarkus.io/guides/resteasy-reactive)): A Jakarta REST implementation utilizing build time processing and Vert.x. - This extension is not compatible with the quarkus-resteasy extension, or any of the extensions that depend on it. -- Hibernate ORM with Panache ([guide](https://quarkus.io/guides/hibernate-orm-panache)): Simplify your persistence code for Hibernate ORM via the - active record or the repository pattern -- Reactive PostgreSQL client ([guide](https://quarkus.io/guides/reactive-sql-clients)): Connect to the PostgreSQL database using the reactive pattern - -## Provided Code - -### Hibernate ORM - -Create your first JPA entity - -[Related guide section...](https://quarkus.io/guides/hibernate-orm) - -[Related Hibernate with Panache section...](https://quarkus.io/guides/hibernate-orm-panache) - -### RESTEasy Reactive - -Easily start your Reactive RESTful Web Services - -[Related guide section...](https://quarkus.io/guides/getting-started-reactive#reactive-jax-rs-resources) - -### RESTEasy Reactive Qute - -Create your web page using Quarkus RESTEasy Reactive & Qute - -[Related guide section...](https://quarkus.io/guides/qute#type-safe-templates) +If you want to learn more about building native executables, please consult https://quarkus.io/guides/maven-tooling. \ No newline at end of file