feat: README
This commit is contained in:
parent
258a478d98
commit
6646ad281f
2 changed files with 22 additions and 1 deletions
|
@ -3,7 +3,10 @@
|
||||||
## Requirements
|
## Requirements
|
||||||
|
|
||||||
- Node.js >= 12.18.2
|
- Node.js >= 12.18.2
|
||||||
- Yarn >= 1.17
|
- Yarn >= 1.17 - [Installation Page](https://classic.yarnpkg.com/en/docs/install)
|
||||||
|
- MongoDB >= v4.2.8
|
||||||
|
- A SMTP server
|
||||||
|
- A S3 Bucket
|
||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
|
|
||||||
|
@ -11,6 +14,9 @@ Before using the server you have to install all the packages required
|
||||||
|
|
||||||
Use the `yarn install` command at the root (take a long time)
|
Use the `yarn install` command at the root (take a long time)
|
||||||
|
|
||||||
|
Then you have to fill the `.env`. We advise you to copy and paste the `.env.example` file as a example for the real `.env`
|
||||||
|
|
||||||
|
|
||||||
## Usage in a development environment
|
## Usage in a development environment
|
||||||
|
|
||||||
`yarn serve`
|
`yarn serve`
|
||||||
|
|
15
README_fr.md
Normal file
15
README_fr.md
Normal file
|
@ -0,0 +1,15 @@
|
||||||
|
## Démarrage du serveur (mode développement)
|
||||||
|
|
||||||
|
Vous devez utiliser deux terminal simultanément ouvert à la racine
|
||||||
|
|
||||||
|
Dans le premier terminal utilisez `yarn serve` afin de démarrer le serveur de développement
|
||||||
|
|
||||||
|
Dans le deuxième terminal utilisez `yarn dev` afin de démarrer le compilateur TypeScript
|
||||||
|
|
||||||
|
## Compilation du code afin de l'executer dans un environment de production
|
||||||
|
|
||||||
|
A la racine, `yarn build && yarn assets`. Cette commande va d'une part compiler le code TypeScript en Node.js et d'une autre part éxecuter le script Gulp.js afin de générer les fichiers statiques adaptés à une utilisation en production.
|
||||||
|
|
||||||
|
## Démarrage du serveur (mode production)
|
||||||
|
|
||||||
|
Toujours à la racine utilisez la commande `yarn start` afin de démarer le serveur.
|
Loading…
Reference in a new issue