Skip to content

Commit

Permalink
FEAT ITEM-349-front-ajouter-un-readme-developpement :
Browse files Browse the repository at this point in the history
     - ajout du README-développement.md
     - modification du README.md
  • Loading branch information
EryneKL committed Nov 13, 2024
1 parent 6a4de86 commit feadc97
Show file tree
Hide file tree
Showing 2 changed files with 42 additions and 36 deletions.
40 changes: 40 additions & 0 deletions README-developpement.md
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/).
38 changes: 2 additions & 36 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,14 @@
# 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).

- 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
Expand All @@ -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/).

0 comments on commit feadc97

Please sign in to comment.