N.A.P. Bootstrap

Node API Project Bootstrap

Base de travail pour créer des projets d'applications Web orientiées API REST en NodeJs.

Modules intégrés

• Express Framework d'application Web
• Lodash Librairie utilitaire pour la manipulation de données
• Bookshelf.js ORM SQL
• nconf Gestionnaire de configuration
• bunyan Logger au format JSON

Démarrer avec les sources

# Récupération des sources
git clone https://github.com/bornholm/nap-bootstrap.git
cd nap-bootstrap

# Installation des dépendances
npm install

# Initialisation de la BDD
# npm install sqlite3 # Base de développement
npm run migrate:latest

# Si besoin, installer Bunyan
# sudo npm install -g bunyan
NODE_ENV=development node server | bunyan

Gestion de la configuration

Le fichier config/defaults.js contient déjà quelques valeurs par défaut pour la connexion à la base de données & l'exécution du serveur Web.

Les fichiers de configuration (config/*.js) sont chargés séquentiellement et fusionnés dans l'ordre suivant:

defaults.js <- $(hostname).js <- ${NODE_ENV}.js <- variable d'environnement <- arguments

Explication Si ma machine s'appelle 'foo' et que j'execute mon application avec la variable d'environnement NODE_ENV=production, les paramètres dans config/defaults.js seront écrasés par ceux dans config/foo.js, eux-mêmes écrasés par config/production.js

Voir la documentation du module nconf

Créer un fichier de migration

Dans un terminal

./node_modules/knex/lib/bin/cli.js migrate:make <tag>
vi migrations/*_<tag>.js

migrations/*_.js

'use strict';

// La méthode "up()" est utilisée pour modifier la structure de la base lors
// du passage de script de migration lors d'une montée de version
exports.up = function(knex, Promise) {

  return Promise.all([

    knex.schema.createTable('accounts', function(table) {

      table.charset('utf8'); // Encodage UTF-8
      table.string('email').unique().primary(); // Colonne 'email' avec contrainte d'unicité
      // etc...
    }),

    knex.schema.createTable('tickets', function(table) {

      table.charset('utf8'); // Encodage UTF-8
      table.increments('id').primary(); // Colonne 'id', PK auto inc
      //etc..
    })

  ]);

};

// La méthode "down()" est utilisée pour modifier la structure de la base lors d'un rollback
exports.down = function(knex, Promise) {

  return Promise.all([
    knex.dropTable('accounts'), // On supprime simplement les tables créées dans le sens inverse
    knex.dropTable('tickets'),
  ]);

};

Pour plus d'informations, voir la documentation de Knex.js

Licence

AGPL