sarahroc/todolist-api-5511091

API developed for course 5511091 (Redux Logic)

Open Classrooms - API Todo

Cette API à été développée pour le cours Organisez votre application React avec la logique Redux. Elle a été réaliser afin de pouvoir répondre aux besoins des exercices et de la trame de ce cours. Elle comporte une documentation similaire à ce que vous pourriez trouver avec toutes API.

Pour réaliser cette API, nous avons utiliser AdonisJS et SQLite.

Requis

• NodeJS 8 ou plus.

Installation

Une fois que les sources sont récupérés, vous devez installer les packages nécessaires au bon fonctinnement du projet en tapant la commande :

npm install

Maintenant que tous les packages sont installés, vous devez initialiser la base de donnée afin de pouvoir utiliser l'API. Pour ce faire, vous devez taper la commande :

npm run initdb

🎉 L'API est maintenant prête à être utilisé !

## Lancer l'API

Afin de pouvoir accéder et intéragir avec l'API, vous devez la lancer en tapant la commande :

npm run start

Une fois démarré, vous pouvez accéder à celle-ci en allant sur http://localhost:3333.

Accéder à la documentation

Cette API comporte une documentation directement dans ses fichiers sources. Afin de pouvoir y accéder, vous devez lancer le serveur Docsify en tapant la commande :

npm run docs

Une fois lancé, la documentation sera accessible depuis http://localhost:3000.