api-todolist

Stateless and scalable Todo List API in Node JS

Installation

git clone https://github.com/YliesC/api-todolist.git
cd api-todolist
yarn install

Run development server

yarn start

Build and serve in production

yarn build
yarn serve

Tests

yarn typecheck
yarn test

Dependencies

• body-parser: Node.js body parsing middleware
• compression: Node.js compression middleware
• express: Fast, unopinionated, minimalist web framework
• helmet: help secure Express/Connect apps with various HTTP headers
• mongoose: Mongoose MongoDB ODM
• swagger-ui-express: Swagger UI Express

Dev Dependencies

• babel-cli: Babel command line.
• babel-plugin-transform-flow-strip-types: Strip flow type annotations from your output code.
• babel-preset-env: A Babel preset for each environment.
• babel-preset-flow: Babel preset for all Flow plugins.
• chakram: Chakram is an API testing framework designed to test JSON REST endpoints. The library offers a BDD testing style and fully exploits javascript promises
• flow-bin: Binary wrapper for Flow - A static type checker for JavaScript
• mocha: simple, flexible, fun test framework
• nodemon: Simple monitor script for use during development of a node.js app.

Documentation

To access the OpenAPI documentation, please visit : https://localhost:3000/doc from your local environment.

Docker

• Docker

Lancer

Rendez vous à la racine du projet :

• docker-compose build pour construire les images
• docker-compose uppour lancer l'environnement

N'oubliez pas de changer l'host de connection pour mongoose en mongo (server.js)

License

AGPL-3.0