-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #178 from abes-esr/ITEM-347-MODIFIER-LES-README
Item 347 modifier les readme
- Loading branch information
Showing
2 changed files
with
59 additions
and
83 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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/). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,92 +1,28 @@ | ||
| # Vuetify (Default) | ||
| # item-client | ||
|
|
||
| ## Icons links | ||
| Vous êtes sur le README usager. Si vous souhaitez accéder au README développement, veuillez suivre ce lien : [README-developpement](README-developpement.md) | ||
|
|
||
| https://pictogrammers.com/library/mdi/ | ||
| [](https://github.com/abes-esr/item-client/actions/workflows/build-test-pubtodockerhub.yml) [](https://hub.docker.com/r/abesesr/item/) | ||
|
|
||
| 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. | ||
| **I**nterface de **T**raitement des **E**xemplaires en **M**asse dans le Sudoc (partie client). | ||
|
|
||
| ## ❗️ Important Links | ||
| - URL de production : https://item.sudoc.fr | ||
| - Documentation utilisateur : http://documentation.abes.fr/aideitem/index.html | ||
|
|
||
| - 📄 [Docs](https://vuetifyjs.com/) | ||
| - 🚨 [Issues](https://issues.vuetifyjs.com/) | ||
| - 🏬 [Store](https://store.vuetifyjs.com/) | ||
| - 🎮 [Playground](https://play.vuetifyjs.com/) | ||
| - 💬 [Discord](https://community.vuetifyjs.com) | ||
| Item nécessite de se logger. Vous devrez donc disposer d'un droit d'accès à l'application pour pouvoir l'utiliser. | ||
|
|
||
| ## 💿 Install | ||
| ## Usage | ||
|
|
||
| Set up your project using your preferred package manager. Use the corresponding command to install the dependencies: | ||
| 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 | ||
|
|
||
| | 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` | | ||
| Chacune de ces demandes sera envoyée à item-back qui effectuera les traitements demandés. | ||
|
|
||
| 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 | ||
| ``` | ||
|
|
||
| (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 | ||
| ``` | ||
|
|
||
| (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 | ||
| npm run prettier | ||
| ``` | ||
| 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. |