diff --git a/README.fr.md b/README.fr.md new file mode 100644 index 0000000000000000000000000000000000000000..4a1473324df50efd8902599ea8df568916da3cb5 --- /dev/null +++ b/README.fr.md @@ -0,0 +1,33 @@ +# BACK +## Solution ERP SIL 2021-2022 + +Ce dépôt contient le composant BACK pour la version SIL du projet ERP +de M2 2021-2022. + +Ce projet est soumis au [contrat de licence CeCILL-B](https://cecill.info/licences/Licence_CeCILL-B_V1-fr.html). + +### Qu'est-ce que c'est ? + +BACK est le composant gérant la documentation comptable et étant également +responsable de la gestion des stocks pour les articles à vendre. +L'application fournit également aux autres services les informations +sur les produits disponibles tels que les prix de chaque article. + +### Exécution + +BACK est une application Web [Java Spring](https://spring.io/) utilisant +le [système Gradle](https://gradle.org/). + +Gradle permet d'essayer rapidement l'application en lançant un serveur +Web de test [Apache TomCat](https://tomcat.apache.org/) hébergeant +le programme. Il permet également de la déployer rapidement sous la forme +d'une archive WAR pouvant être installée sur un serveur de production +Apache TomCat ou [Oracle Glassfish](https://www.oracle.com/middleware/technologies/glassfish-server.html). + +Il est conseillé d'utiliser un IDE Java pour exécuter et déployer l'application. + +* [JetBrains IntelliJ IDEA](https://www.jetbrains.com/idea/) (propriétaire, nécessite une licence) +* [Apache NetBeans](https://netbeans.apache.org/) (gratuit et *open-source*) +* [Eclipse IDE for Java Developers](https://www.eclipse.org/downloads/packages/) (grauit et *open-source*) + +TODO: Insérer les commandes Gradle. diff --git a/README.md b/README.md new file mode 100644 index 0000000000000000000000000000000000000000..43b9c913d62ab2f00720d16cc7a606dbd7f39d3d --- /dev/null +++ b/README.md @@ -0,0 +1,33 @@ +# BACK +## 2021-2022 SIL ERP solution + +This is the BACK component for the 2021-2022 M2 SIL version +of the ERP system, a project for the ERP subject. + +This work is licensed under the [CeCILL-B license agreement](https://cecill.info/licences/Licence_CeCILL-B_V1-en.html). + +### What's this? + +BACK is the component that handles financial documentation +as well as a Stock Management system for the articles for sale. +It also provides other components information about the available +products such as the number of each article in stock as well as their +price. + +### Running + +BACK is a [Java Spring](https://spring.io/) Web application built using +the [Gradle Build Tool](https://gradle.org/). + +Gradle allows you to quickly test the application by running a local +test [Apache TomCat](https://tomcat.apache.org/) server that hosts +the application. It also allows you to quickly build a WAR archive +for deployment on a production Apache TomCat or [Oracle Glassfish](https://www.oracle.com/middleware/technologies/glassfish-server.html) server. + +It is recommended to use a Java IDE to run and deploy the application. + +* [JetBrains IntelliJ IDEA](https://www.jetbrains.com/idea/) (proprietary, requires a license) +* [Apache NetBeans](https://netbeans.apache.org/) (free and open-source) +* [Eclipse IDE for Java Developers](https://www.eclipse.org/downloads/packages/) (free and open-source) + +TODO: Insert manual Gradle commands.