From 48c90a3027dbc2c8c9895c1bb78e55668e7b4073 Mon Sep 17 00:00:00 2001 From: SamuelQuetin Date: Tue, 12 Nov 2024 11:36:41 +0100 Subject: [PATCH 1/8] Modif du readme --- README.md | 112 +++++++++++++++--------------------------------------- 1 file changed, 30 insertions(+), 82 deletions(-) diff --git a/README.md b/README.md index b2cab61..ee15b9e 100644 --- a/README.md +++ b/README.md @@ -1,92 +1,40 @@ -# Vuetify (Default) +# item-client -## Icons links +[![build-test-pubtodockerhub](https://github.com/abes-esr/item-client/actions/workflows/build-test-pubtodockerhub.yml/badge.svg)](https://github.com/abes-esr/item-client/actions/workflows/build-test-pubtodockerhub.yml) [![Docker Pulls](https://img.shields.io/docker/pulls/abesesr/item.svg)](https://hub.docker.com/r/abesesr/item/) -https://pictogrammers.com/library/mdi/ +**I**nterface de **T**raitement des **E**xemplaires en **M**asse dans le Sudoc (partie client). -This is the official scaffolding tool for Vuetify, designed to give you a head start in building your new Vuetify application. It sets up a base template with all the necessary configurations and standard directory structure, enabling you to begin development without the hassle of setting up the project from scratch. +- URL de production : https://item.sudoc.fr +- Documentation utilisateur : http://documentation.abes.fr/aideitem/index.html -## ❗️ Important Links +Ce dépôt héberge le code source de l'interface utilisateur de item (développée en VueJS). +Cette interface utilisateur fonctionne avec son API développée en Java : https://github.com/abes-esr/item-api/ +Et l'application item complète peut être déployée via Docker à l'aide de ce dépôt : https://github.com/abes-esr/item-docker/ +Les principaux plugins sont VueJs 3, Vite, Pinia, Vue-router, Vuetify et Axios. -- 📄 [Docs](https://vuetifyjs.com/) -- 🚨 [Issues](https://issues.vuetifyjs.com/) -- 🏬 [Store](https://store.vuetifyjs.com/) -- 🎮 [Playground](https://play.vuetifyjs.com/) -- 💬 [Discord](https://community.vuetifyjs.com) - -## 💿 Install - -Set up your project using your preferred package manager. Use the corresponding command to install the dependencies: - -| Package Manager | Command | -| --------------------------------------------------------- | -------------- | -| [yarn](https://yarnpkg.com/getting-started) | `yarn install` | -| [npm](https://docs.npmjs.com/cli/v7/commands/npm-install) | `npm install` | -| [pnpm](https://pnpm.io/installation) | `pnpm install` | -| [bun](https://bun.sh/#getting-started) | `bun install` | - -After completing the installation, your environment is ready for Vuetify development. - -## ✨ Features - -- 🖼️ **Optimized Front-End Stack**: Leverage the latest Vue 3 and Vuetify 3 for a modern, reactive UI development experience. [Vue 3](https://v3.vuejs.org/) | [Vuetify 3](https://vuetifyjs.com/en/) -- 🗃️ **State Management**: Integrated with [Pinia](https://pinia.vuejs.org/), the intuitive, modular state management solution for Vue. -- 🚦 **Routing and Layouts**: Utilizes Vue Router for SPA navigation and vite-plugin-vue-layouts for organizing Vue file layouts. [Vue Router](https://router.vuejs.org/) | [vite-plugin-vue-layouts](https://github.com/JohnCampionJr/vite-plugin-vue-layouts) -- ⚡ **Next-Gen Tooling**: Powered by Vite, experience fast cold starts and instant HMR (Hot Module Replacement). [Vite](https://vitejs.dev/) -- 🧩 **Automated Component Importing**: Streamline your workflow with unplugin-vue-components, automatically importing components as you use them. [unplugin-vue-components](https://github.com/antfu/unplugin-vue-components) - -These features are curated to provide a seamless development experience from setup to deployment, ensuring that your Vuetify application is both powerful and maintainable. - -## 💡 Usage - -This section covers how to start the development server and build your project for production. - -### Starting the Development Server - -To start the development server with hot-reload, run the following command. The server will be accessible at [http://localhost:3000](http://localhost:3000): - -```bash -yarn dev +## Project setup ``` - -(Repeat for npm, pnpm, and bun with respective commands.) - -> Add NODE_OPTIONS='--no-warnings' to suppress the JSON import warnings that happen as part of the Vuetify import mapping. If you are on Node [v21.3.0](https://nodejs.org/en/blog/release/v21.3.0) or higher, you can change this to NODE_OPTIONS='--disable-warning=5401'. If you don't mind the warning, you can remove this from your package.json dev script. - -### Building for Production - -To build your project for production, use: - -```bash -yarn build +npm install ``` +une fois installer, il faut copier le ``.env-dist`` pour avoir un ``.env`` et completer les variables d'environement, tel que l'url du back. -(Repeat for npm, pnpm, and bun with respective commands.) - -Once the build process is completed, your application will be ready for deployment in a production environment. - -## 💪 Support Vuetify Development - -This project is built with [Vuetify](https://vuetifyjs.com/en/), a UI Library with a comprehensive collection of Vue components. Vuetify is an MIT licensed Open Source project that has been made possible due to the generous contributions by our [sponsors and backers](https://vuetifyjs.com/introduction/sponsors-and-backers/). If you are interested in supporting this project, please consider: - -- [Requesting Enterprise Support](https://support.vuetifyjs.com/) -- [Sponsoring John on Github](https://github.com/users/johnleider/sponsorship) -- [Sponsoring Kael on Github](https://github.com/users/kaelwd/sponsorship) -- [Supporting the team on Open Collective](https://opencollective.com/vuetify) -- [Becoming a sponsor on Patreon](https://www.patreon.com/vuetify) -- [Becoming a subscriber on Tidelift](https://tidelift.com/subscription/npm/vuetify) -- [Making a one-time donation with Paypal](https://paypal.me/vuetify) - -## 📑 License - -[MIT](http://opensource.org/licenses/MIT) - -Copyright (c) 2016-present Vuetify, LLC - -## Prettier - -To indent code fo the project, use: - -```bash +### Compiles and hot-reloads for development +``` +npm run dev +``` +l'url est précisé dans le resultat de la ligne de commande si dessus. +### Compiles for build +``` +npm run build +``` +### Compiles for preview +``` +npm run preview +``` +### Compiles for prettier +``` npm run prettier ``` + +### Customize configuration +See [Configuration Reference](https://cli.vuejs.org/config/). From 6a4de865a681d39c7fe9df87ac67362f31578721 Mon Sep 17 00:00:00 2001 From: EryneKL <97091460+EryneKL@users.noreply.github.com> Date: Wed, 13 Nov 2024 16:37:39 +0100 Subject: [PATCH 2/8] FEAT ITEM-347-MODIFIER-LES-README : - ajout d'explications --- README.md | 34 ++++++++++++++++++++++++++++------ 1 file changed, 28 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index ee15b9e..dbc5cb4 100644 --- a/README.md +++ b/README.md @@ -7,30 +7,52 @@ - URL de production : https://item.sudoc.fr - Documentation utilisateur : http://documentation.abes.fr/aideitem/index.html -Ce dépôt héberge le code source de l'interface utilisateur de item (développée en VueJS). -Cette interface utilisateur fonctionne avec son API développée en Java : https://github.com/abes-esr/item-api/ -Et l'application item complète peut être déployée via Docker à l'aide de ce dépôt : https://github.com/abes-esr/item-docker/ -Les principaux plugins sont VueJs 3, Vite, Pinia, Vue-router, Vuetify et Axios. +Ce dépôt héberge le code source de l'interface utilisateur de Item (développée en VueJS) codée en VueJs 3. +Cette interface utilisateur fonctionne en lien avec son API développée en Java : https://github.com/abes-esr/item-api/ +L'application Item complète peut être déployée via Docker à l'aide de ce dépôt : https://github.com/abes-esr/item-docker/ . +Les principaux plugins installés dans ce projet sont : Vite, Pinia, Vue-router, Vuetify et Axios. + +Item nécessite de se logger. Vous devrez donc disposer d'un droit d'accès à l'application pour pouvoir l'utiliser. + +## Usage + +Item permet de : +* Calculer ses taux de recouvrement +* Gérer ses taux de recouvrement +* Créer des exemplaires +* Gérer ses créations d'exemplaires +* Modifier des exemplaires +* Gérer ses modifications d'exemplaires +* Supprimer des exemplaires +* Gérer ses suppressions d'exemplaires + +Chacune de ces demandes sera envoyée à item-back qui effectuera les traitements demandés. + +Des emails récapitulatifs seront envoyés durant les traitements afin d'informer sur l'état de leur réalisation. Un email valide est donc nécessaire. + ## Project setup ``` npm install ``` -une fois installer, il faut copier le ``.env-dist`` pour avoir un ``.env`` et completer les variables d'environement, tel que l'url du back. +Une fois installée, il faut dupliquer le ``.env-dist`` puis renommer le duplicata en ``.env``. Completer ensuite les variables d'environnement dans le ``.env``. ### Compiles and hot-reloads for development ``` npm run dev ``` -l'url est précisé dans le resultat de la ligne de commande si dessus. +Une fois cette commande lancée, l'url de l'application sera affichée (dans le terminal ou dans les logs, selon l'environnement de déploiement). + ### Compiles for build ``` npm run build ``` + ### Compiles for preview ``` npm run preview ``` + ### Compiles for prettier ``` npm run prettier From feadc971be5e2f48b847630aaeb8ecdc43a8673a Mon Sep 17 00:00:00 2001 From: EryneKL <97091460+EryneKL@users.noreply.github.com> Date: Wed, 13 Nov 2024 16:49:03 +0100 Subject: [PATCH 3/8] =?UTF-8?q?FEAT=20ITEM-349-front-ajouter-un-readme-dev?= =?UTF-8?q?eloppement=20:=20=20=20=20=20=20-=20ajout=20du=20README-d=C3=A9?= =?UTF-8?q?veloppement.md=20=20=20=20=20=20-=20modification=20du=20README.?= =?UTF-8?q?md?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README-developpement.md | 40 ++++++++++++++++++++++++++++++++++++++++ README.md | 38 ++------------------------------------ 2 files changed, 42 insertions(+), 36 deletions(-) create mode 100644 README-developpement.md diff --git a/README-developpement.md b/README-developpement.md new file mode 100644 index 0000000..1e0620a --- /dev/null +++ b/README-developpement.md @@ -0,0 +1,40 @@ +# item-client + +Le langage utilisé est JavaScript, avec le framework VueJs 3. + +Ce dépôt héberge le code source de l'interface utilisateur de Item (développée en VueJS) codée en VueJs 3. +Cette interface utilisateur fonctionne en lien avec son API développée en Java : https://github.com/abes-esr/item-api/ +L'application Item complète peut être déployée via Docker à l'aide de ce dépôt : https://github.com/abes-esr/item-docker/ . +Les principaux plugins installés dans ce projet sont : Vite, Pinia, Vue-router, Vuetify et Axios. + +## Installation du projet et démarrage + +### Installation du projet +``` +npm install +``` +Une fois installé, il faut dupliquer le ``.env-dist`` puis renommer le duplicata en ``.env``. Completer ensuite les variables d'environnement dans le ``.env``. + +### Compilation et rechargement à chaud pour le développement +``` +npm run dev +``` +Une fois cette commande lancée, l'url de l'application sera affichée (dans le terminal ou dans les logs, selon l'environnement de déploiement). + +### Compilation complète +``` +npm run build +``` + +### Compilation pour prévisualisation +``` +npm run preview +``` + +### Compilation "prettier" +``` +npm run prettier +``` + +### Configurations personnalisées +See [Configuration Reference](https://cli.vuejs.org/config/). diff --git a/README.md b/README.md index dbc5cb4..e1e7407 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,7 @@ # item-client +Vous êtes sur le README usager. Si vous souhaitez accéder au README développement, veuillez suivre ce lien : [README-developpement](README-developpement.md) + [![build-test-pubtodockerhub](https://github.com/abes-esr/item-client/actions/workflows/build-test-pubtodockerhub.yml/badge.svg)](https://github.com/abes-esr/item-client/actions/workflows/build-test-pubtodockerhub.yml) [![Docker Pulls](https://img.shields.io/docker/pulls/abesesr/item.svg)](https://hub.docker.com/r/abesesr/item/) **I**nterface de **T**raitement des **E**xemplaires en **M**asse dans le Sudoc (partie client). @@ -7,11 +9,6 @@ - URL de production : https://item.sudoc.fr - Documentation utilisateur : http://documentation.abes.fr/aideitem/index.html -Ce dépôt héberge le code source de l'interface utilisateur de Item (développée en VueJS) codée en VueJs 3. -Cette interface utilisateur fonctionne en lien avec son API développée en Java : https://github.com/abes-esr/item-api/ -L'application Item complète peut être déployée via Docker à l'aide de ce dépôt : https://github.com/abes-esr/item-docker/ . -Les principaux plugins installés dans ce projet sont : Vite, Pinia, Vue-router, Vuetify et Axios. - Item nécessite de se logger. Vous devrez donc disposer d'un droit d'accès à l'application pour pouvoir l'utiliser. ## Usage @@ -29,34 +26,3 @@ Item permet de : Chacune de ces demandes sera envoyée à item-back qui effectuera les traitements demandés. Des emails récapitulatifs seront envoyés durant les traitements afin d'informer sur l'état de leur réalisation. Un email valide est donc nécessaire. - - -## Project setup -``` -npm install -``` -Une fois installée, il faut dupliquer le ``.env-dist`` puis renommer le duplicata en ``.env``. Completer ensuite les variables d'environnement dans le ``.env``. - -### Compiles and hot-reloads for development -``` -npm run dev -``` -Une fois cette commande lancée, l'url de l'application sera affichée (dans le terminal ou dans les logs, selon l'environnement de déploiement). - -### Compiles for build -``` -npm run build -``` - -### Compiles for preview -``` -npm run preview -``` - -### Compiles for prettier -``` -npm run prettier -``` - -### Customize configuration -See [Configuration Reference](https://cli.vuejs.org/config/). From 90365da3ea9061773ccd9348954b36de5b56cc86 Mon Sep 17 00:00:00 2001 From: SamuelQuetin Date: Wed, 27 Nov 2024 11:20:33 +0100 Subject: [PATCH 4/8] ITEM-392 FEAT Ajout Composant Maintenance avec variable dans .env-dist --- .env-dist | 1 + src/App.vue | 165 ++++++++++++----------- src/components/Structure/Maintenance.vue | 30 +++++ 3 files changed, 114 insertions(+), 82 deletions(-) create mode 100644 src/components/Structure/Maintenance.vue diff --git a/.env-dist b/.env-dist index 5f3aa6e..7a5db3c 100644 --- a/.env-dist +++ b/.env-dist @@ -1,2 +1,3 @@ VITE_API_URL= VITE_API_URL_IDREF= +VITE_API_MAINTENANCE=false diff --git a/src/App.vue b/src/App.vue index 7f4da05..0108a96 100644 --- a/src/App.vue +++ b/src/App.vue @@ -1,61 +1,62 @@ diff --git a/src/components/Structure/Maintenance.vue b/src/components/Structure/Maintenance.vue new file mode 100644 index 0000000..f667a50 --- /dev/null +++ b/src/components/Structure/Maintenance.vue @@ -0,0 +1,30 @@ + + + From 4a681a3c19f4eeeac2996eafabaa51e5b9d2bf45 Mon Sep 17 00:00:00 2001 From: SamuelQuetin Date: Wed, 27 Nov 2024 11:22:45 +0100 Subject: [PATCH 5/8] ITEM-392 FIX nommage variable --- .env-dist | 2 +- src/components/Structure/Maintenance.vue | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/.env-dist b/.env-dist index 7a5db3c..ece7ba9 100644 --- a/.env-dist +++ b/.env-dist @@ -1,3 +1,3 @@ VITE_API_URL= VITE_API_URL_IDREF= -VITE_API_MAINTENANCE=false +VITE_MAINTENANCE=false diff --git a/src/components/Structure/Maintenance.vue b/src/components/Structure/Maintenance.vue index f667a50..d7b2393 100644 --- a/src/components/Structure/Maintenance.vue +++ b/src/components/Structure/Maintenance.vue @@ -19,7 +19,7 @@ import { computed } from 'vue'; -const warningDialog = computed(() => import.meta.env.VITE_API_MAINTENANCE === 'true'); +const warningDialog = computed(() => import.meta.env.VITE_MAINTENANCE === 'true');