eniocsj / njinga.js

Skeleton for simple A.P.I.

Njinga JS

Skeleton for simple A.P.I.

1. How to use

npm i
npm start

2. Settings

2.1 Environment variables

These environment variables are set to their default values in the .env file as in the example file .env.example.

• ENV Environment mode. Default: 'development'

• PORT Port used in server. Default = 8080

• SQL_HOST

• SQL_DATABASE

• SQL_PORT

• SQL_USERNAME

• SQL_PASSWORD

• SQL_DIALECT Supported dialects:

  • postgres
  • sqlite
  • mysql
  • mssql

3. Structure

3.1 Files

• README.md This file ;-)
• cmd.js Utils to import and export databases.

3.2 Folders

• controllers Application controllers.

• middlewares Application middlewares. Initial file number represents your initialization order.

• resources Application web routes.

• settings Application settings. Packages are started here.

• databases/models Application data models.

• system System utils.