server/README.md

903 B

API/Serveur - associations.espacecondorcet.org

Requirements

  • Node.js >= 12.18.2
  • Yarn >= 1.17 - Installation Page
  • MongoDB >= v4.2.8
  • A SMTP server
  • A S3 Bucket

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)

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

yarn serve

Compilation before use in a production environment

yarn build && yarn assets

Usage in a production environment

yarn serve

Random notes

For lefuturiste/express-redis-middleware in package.json, if you want to do local development for the cache lib :

{
"express-redis-cache": "portal:./../../express-redis-middleware/",
}