Selaa lähdekoodia

update readme

Olivier Massot 4 vuotta sitten
vanhempi
commit
607ea3e5cc
1 muutettua tiedostoa jossa 29 lisäystä ja 23 poistoa
  1. 29 23
      README.md

+ 29 - 23
README.md

@@ -1,9 +1,9 @@
-# admin
+# app
 
 [![pipeline status](http://gitlab.2iopenservice.com/vincent/admin/badges/master/pipeline.svg)](http://gitlab.2iopenservice.com/vincent/admin/-/commits/master)
 [![coverage report](http://gitlab.2iopenservice.com/vincent/admin/badges/master/coverage.svg)](http://gitlab.2iopenservice.com/vincent/admin/-/commits/master)
 
-Frontend Opentalent développé avec Vue.js 2 + NuxtJs 2
+Frontend développé avec Vue.js 2 + NuxtJs 2
 
 A voir:
 
@@ -14,36 +14,27 @@ A voir:
 * [typescriptlang.org](https://www.typescriptlang.org/)
 * [jestjs.io](https://jestjs.io/docs/getting-started)
 * [cypress.io](https://docs.cypress.io/guides/getting-started/installing-cypress)
+* [pm2.keymetrics.io](https://pm2.keymetrics.io/docs/usage/quick-start//)
 
-### Build Setup
 
-```bash
-# install dependencies
-$ yarn install
+## Opérations courantes
 
-# serve with hot reload at localhost:3000
-$ yarn dev
+### Déployer comme un service
 
-# build for production and launch server
-$ yarn build
-$ yarn start
+> Prérequis : PM2 doit être installé de manière globale sur la machine hôte (https://nuxtjs.org/deployments/pm2/)
 
-# generate static project
-$ yarn generate
+Pour déployer le projet en mode SSR, on commence par mettre à jour et compiler :
 
-# generate doc
-$ yarn docs
-```
+    yarn install
 
-For detailed explanation on how things work, check out [Nuxt.js docs](https://nuxtjs.org).
+    // en prod
+    yarn build:prod
+    
+    // en preprod
+    yarn build:preprod
 
-## Déployer comme un service
+On lance ensuite le service avec:
 
-> Prérequis : PM2 doit être installé de manière globale (https://nuxtjs.org/deployments/pm2/)
-
-Pour déployer le projet en mode SSR :
-
-    yarn build
     pm2 start
 
 Vérifier le statut avec :
@@ -56,6 +47,21 @@ On pourra ensuite interagir avec le service ainsi :
     pm2 stop app
     pm2 logs app
 
+### Lancer les tests
+
+Pour lancer les tests unitaires:
+
+    jest
+
+### Générer la doc
+
+Pour regénérer la documentation automatique:
+
+    yarn docs
+
+
+## Plus d'infos
+
 ## Structure du projet
 
 | Répertoire | Rôle |