Cette API à été développée pour le cours Organisez votre application React avec la logique Redux. Elle a été réaliser de manière à 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.
- NodeJS 8 ou plus.
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 installMaintenant 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 migration:run🎉 L'API est maintenant prête à être utilisé !
Pour accéder et intéragir avec l'API, vous devez la lancer en tapant la commande :
npm run startUne fois démarré, vous pouvez y accéder en allant sur http://localhost:3333.
Cette API comporte une documentation directement dans ses fichiers sources. Dans le but de pouvoir y accéder, vous devez lancer le serveur Docsify en tapant la commande :
npm run docsUne fois lancé, la documentation sera accessible depuis http://localhost:3000.