From b1d01656e068467dc813007e746cd692e5896abb Mon Sep 17 00:00:00 2001 From: Matthieu Bessat Date: Sat, 1 Aug 2020 18:14:47 +0200 Subject: [PATCH] feat: start of README.md --- README.md | 22 +++++++++++++++++++++- 1 file changed, 21 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 6e70071..46bbf17 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,24 @@ -# Forum virtuel des associations +# API/Serveur - associations.espacecondorcet.org + +## Requirements + +- Node.js >= 12.18.2 +- Yarn >= 1.17 ## Installation +Before using the server you have to install all the packages required + +Use the `yarn install` command at the root (take a long time) + +## Usage in a development environment + +`yarn serve` + +## Compilation before use in a production environment + +`yarn build && yarn assets` + +## Usage in a production environment + +`yarn serve` \ No newline at end of file