Retour

Node.js Starter API

Un Starter Pack d'API Node.js prêt à l'emploi ! Aucune configuration serveur. Gagnez du temps dans vos projets. Inclus des middlewares et outils utiles.

Usage

Nous partons du principe que vous connaissez déjà Node.js et son fonctionnement. Ce starter permet de rapidement déployer une application Node.js. Si vous ne connaissez pas cet outil, veuillez vous référer à sa documentation.

Avant tout vous avez besoin de Node.js à jour.

L'application inclut l'ODM Mongoose comme manager de MongoDB. Vous pouvez choisir entre deux méthodes de connection à la base de donnée.

Connection via le client Mongoose

db.mongooseConnection()

Connection via le client MongoDB

db.mongoConnection()

Installation

Initialisation

Au premier lancement de l'application, utilisez les commandes suivantes :

#Developpment
npm run dev-init

#Production
npm run prod-init

Puis utilisez les commandes suivantes pour lancer l'application disponible sur localhost:3000/v1

#Developpment
npm run dev

#Production
npm run start

Examples

Découvrez quelques examples d'utilisations disponibles dans /controllers/examples

API Auth

Ce pack embarque un middleware d'authentification d'API déjà prêt à l'emploi. Plus d'informations sur son utilisation sur GitHub.

Et voilà !

Votre API est désormais prête à l'emploi.
Editez le fichier ./core/config/config.json pour configurer simplement votre application.

Plus de documentation sur GitHub.