feat: start of README.md
This commit is contained in:
parent
bac5347c65
commit
b1d01656e0
1 changed files with 21 additions and 1 deletions
22
README.md
22
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`
|
Loading…
Reference in a new issue