OrnitoJS

Command line interface to start a new nodejs API based on express framework with Ornito structure defined from past projects.

• async await functions

• email builder using sendgrid service

• jobs using cronjob

• resources creation from command line

• relational and non-relational databases

• eslint

• tests

• convention over configuration

• knex.js

Setup

Ornito JS allow you to easily start an API and code oriented to modules. strives to be an easily embeddable and beautiful command line interface for Node.js.

Ornito JS needs the following tools/techonologies to be able to start up.

• Nodemon

• Nodejs > 7.6.0

• Postgres

• Mongodb (if you're going to use it)

• Redis (if you're going to use it)

Note: Ornito CLI is still in active development, we want to deliver more features like eslint, iugu integration and more.

Command line

npm install -g ornitojs
ornito start

Running

npm start
npm testnpm run linter

Creating a new module

ornito module user

Database configuration

➡️ ./knexfile.js

development: {
  client: 'postgresql',
  connection: {
    database: 'yourdb',
    user: 'youruser',
    password: 'yourpassword'
  },
  pool: {
    min: 2,
    max: 10
  },
  migrations: {
    tableName: 'migrations'
  },
  seeds: {
    directory: './seeds/dev/'
  }
},

➡️ ./src/config/ENV.json

{  "db_host": "postgres://youruser:yourpassword@localhost:5432/yourdb",  "sendgrid_api_key": "",  "iugu": {    "url": "https://api.iugu.com/v1/",    "api_key": "",    "api_token": ""
  },  "cloudinary": {    "cloud_name": "",    "api_key": "",    "api_secret": "",    "env_variable": ""
  }
}