The server that run the back-end and the rendering of public pages
assets | ||
src | ||
views | ||
.editorconfig | ||
.env.example | ||
.gitignore | ||
.yarnrc.yml | ||
curl-format.txt | ||
deploy.sh | ||
ecosystem.config.js | ||
gulpfile.js | ||
LICENSE | ||
nodemon.json | ||
package.json | ||
presentation.md | ||
README.md | ||
README_fr.md | ||
start.sh | ||
test_mail.js | ||
TODO.md | ||
tsconfig.json | ||
yarn.lock |
PageAssos API/Back-end server
This is the code that run the Node.js back-end that allow public-pages website rendering and the API used by the front-end panel.
Requirements
- Runtime: Node.js >= 12.18.2
- Package manager: Yarn >= 1.17 - Installation Page
- Database: MongoDB >= v4.2.8
- Emails: any SMTP server (to send emails to organizations)
- Object storage: S3-compatible bucket (to store assets uploaded by organizations)
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/",
}