Nodexp

A simple command-line tool for Node.js APIs boilerplate, inspirade on Ruby on Rails and Express generator

⚠️⚠️ This module is on development mode and it is not ready to be used in real web applications yet ⚠️⚠️

Index

• Dependencies
• Installation
• Usage
• Support

Dependencies

• Node.js v6+
• NPM v3+
• MongoDB 3.4

Installation

Download from NPM:

npm install -g nodexp

Usage

nodexp <command>

Quick Start

Create a new project:

nodexp new awesome-api

Install the dependencies:

cd awesome-api
npm install

Run your app:

npm start

Visit localhost:3000

Commands

new

Creates a new project

nodexp new <project-name>

e.g

nodexp new awesome-api

generate

Generate some boilerplate.

usage:

nodexp generate <boilerplate>

alias: nodexp g <boilerplate>

See the boilerplate section below to get a list of available generators

Boilerplates

All those boilerplates can be generated through nodexp generate command.

model

nodexp generate model <model-name>

Creates a new model inside the /model directory

nodexp generate model User

You also can pass some initial properties and their respective types

nodexp g model User name:string age:number

Support

Please open an issue for support.

Roadmap

• Organize the APP in modules
• Controller/Routes boilerplate generetor
• Model boilerplate generetor
• Add migrations
• Add support to SQL Databases
• Add default authentication (Like Meteor.js)
• Add pattern/support to call external Hooks
• Add pattern/support to call external Services