server/README.md

42 lines
903 B
Markdown
Raw Normal View History

2020-08-01 16:14:47 +00:00
# API/Serveur - associations.espacecondorcet.org
## Requirements
- Node.js >= 12.18.2
2020-08-03 16:31:02 +00:00
- Yarn >= 1.17 - [Installation Page](https://classic.yarnpkg.com/en/docs/install)
- MongoDB >= v4.2.8
- A SMTP server
- A S3 Bucket
2020-07-11 22:42:00 +00:00
## Installation
2020-08-01 16:14:47 +00:00
Before using the server you have to install all the packages required
Use the `yarn install` command at the root (take a long time)
2020-08-03 16:31:02 +00:00
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`
2020-08-01 16:14:47 +00:00
## 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 :
```json
{
"express-redis-cache": "portal:./../../express-redis-middleware/",
}
```