CT-CORE

Build the REST API with json metadata.

This is a quick back-end system. You need create more modules, more versions, more APIs.. with only one json metadata

Requirements

• NodeJS 12+
• MongoDB 4.4+

Start MongoDB

mongod --port 27017

I. Getting started with global module

1. Install CT-CORE

npm install -g ct-core

2. Initial application

ct-core init

3. Updating application

ct-core update

4. Configuration environment

cp .env.copy .env

5. Start application

ct-core start

II. Getting started with include as a module

1. Init the project

npm init project-name

Open the file package.json and update tag "scripts"

"scripts": {
  "init": "cross-env START_WITH=init node index.js",
  "start": "cross-env START_WITH=start node index.js",
  "update": "cross-env START_WITH=update node index.js",
  "generate-doc": "cross-env START_WITH=apidoc node index.js",
  "clean-doc": "find . -type f -name '_doc.js' -delete",
  "apidoc": "npm run generate-doc && apidoc -i api/ -o doc/ && npm run clean-doc"
}

Add dependencies

npm install --save ct-core
npm install --save-dev apidoc
npm install --save-dev cross-env

2. Create index.js file

const core = require('ct-core');
const cmd = process.env.START_WITH ? process.env.START_WITH : 'start';
try {
  core(cmd);
} catch (e) {
  console.error(e);
}

3. Configuration environment

cp .env.copy .env

4. Start application as development

npm run start

Now go to homepage http://localhost:3000

III. Add connection to database

1. Connection the MongoDB

Create file: api/database/mongo.json

{
  "driver": "mongoose",
  "connection": "mongodb://{HOST}:{PORT}/{DATABASE}",
  "options": {
    "useNewUrlParser": true,
    "useUnifiedTopology": true,
    "serverSelectionTimeoutMS": 5000
  }
}

Add configuration to setting file: api/setting.json

"database": [
    {
      "MONGO_DB_HOST": "localhost",
      "MONGO_DB_PORT": "27017",
      "MONGO_DB_NAME": "eco",
      "MONGO_DB_USERNAME": "",
      "MONGO_DB_PASSWORD": ""
    }
  ],

2. Connection the MySQL or MariaDB

npm install --save mariadb

Create file: api/database/mariadb.json

{
  "driver": "mariadb",
  "database": "[DATABASE]",
  "config": {
    "connectionLimit" : 10,
    "host"            : "[SERVER]",
    "user"            : "[USERNAME]",
    "password"        : "[PASSWORD]",
    "database"        : "[DATABASE]"
  }
}

Add configuration to setting file: api/setting.json

"database": [
    {
      "MYSQL_DB_PORT": "3306",
      "MYSQL_DB_SERVER": "localhost",
      "MYSQL_DB_DATABASE": "eco",
      "MYSQL_DB_USERNAME": "eco",
      "MYSQL_DB_PASSWORD": "eco"
    }
  ],

3. Connection the SQL Server

npm install --save mssql

Create file: api/database/mssql.json

{
  "driver": "mssql",
  "database": "[DATABASE]",
  "connection": "Server=[SERVER],[PORT];Database=[DATABASE];User Id=[USERNAME];Password=[PASSWORD];",
  "config": {
    "user": "[USERNAME]",
    "password": "[PASSWORD]",
    "server": "[SERVER]",
    "database": "[DATABASE]",
    "connectionTimeout": 15000,
    "requestTimeout": 150000,
    "pool": {
      "min": 1,
      "max": 20,
      "idleTimeoutMillis": 30000
    },
    "options": {
      "port": "[PORT]",
      "appName": "node-mssql",
      "encrypt": false,
      "useUTC": true
    }
  }
}

Add configuration to setting file: api/setting.json

"database": [
    {
      "MSSQL_DB_PORT": "1433",
      "MSSQL_DB_SERVER": "10.0.0.15\\sql2012",
      "MSSQL_DB_DATABASE": "eco",
      "MSSQL_DB_USERNAME": "sa",
      "MSSQL_DB_PASSWORD": "2008"
    }
  ],

IV. How to test application

1. Output

HTTP/1.1 200 OK

[
  {
    "gender": "male",
    "_id": "5e7115bd926d13129e9b1cdf",
    "username": "username",
    "email": "[email protected]",
    "password": "password",
    "age": 65,
    "phone": "0999999999",
    "birthday": "2020-03-17T07:06:16.664Z",
    "salary": 1500.8,
    "avatar": "https://i.pinimg.com/originals/90/b0/b3/90b0b3b15ccecf9efda592b0bdf462aa.jpg",
    "last_ip": "30.230.33.25"
  }
]

Also when doing requests, it's good to know that:

• If you make POST, PUT, PATCH or DELETE requests, changes will be automatically.
• Your request body JSON should be object enclosed, just like the GET output. (for example {"name": "Foobar"})
• Id values are not mutable. Any id value in the body of your PUT or PATCH request will be ignored. Only a value set in a POST request will be respected, but only if not already taken.
• A POST, PUT or PATCH request should include a Content-Type: application/json header to use the JSON in the request body. Otherwise it will result in a 200 OK but without changes being made to the data.

2. Routes

    GET     -> /*/auth/get-token (*)
    GET     -> /*/auth/refresh-token (token)
    GET     -> /*/system/get-captcha (token)
    GET     -> /v1.0.0/setting/default (token)
    GET     -> /v1.0.0/setting/init/:password (token)
    GET     -> /v1.0.0/setting/get-by-id/:id (token,admin)
    PUT     -> /v1.0.0/setting/get-all (token,admin)
    POST    -> /v1.0.0/setting/add (token,admin)
    POST    -> /v1.0.0/setting/edit (token,admin)
    DELETE  -> /v1.0.0/setting/delete (token,admin)
    DELETE  -> /v1.0.0/setting/deletes (token,admin)
    POST    -> /v1.0.0/upload/file (token)
    PUT     -> /v1.0.0/user/login (token)
    PUT     -> /v1.0.0/user/logout (token)
    PUT     -> /v1.0.0/user/login-social (token)
    PUT     -> /v1.0.0/user/admin (token)
    PUT     -> /v1.0.0/user/check-username (token)
    PUT     -> /v1.0.0/user/check-email (token)
    PUT     -> /v1.0.0/user/forgot-password (token)
    PUT     -> /v1.0.0/user/reset-password (token)
    PUT     -> /v1.0.0/user/register-user (token)
    PUT     -> /v1.0.0/user/change-password (token,login)
    PUT     -> /v1.0.0/user/send-password (token,admin)
    POST    -> /v1.0.0/user/add-child (token,login)
    GET     -> /v1.0.0/user/get-children (token,login)
    DELETE  -> /v1.0.0/user/del-child (token,login)
    POST    -> /v1.0.0/user/add-user (token,admin)
    POST    -> /v1.0.0/user/edit-user (token,login)
    GET     -> /v1.0.0/user/get-by-id/:id (token,login)
    GET     -> /v1.0.0/user/get-all (token,admin)
    PUT     -> /v1.0.0/user/active-user (token,admin)
    PUT     -> /v1.0.0/user/disable (token,login)
    DELETE  -> /v1.0.0/user/delete-user (token,admin)
    DELETE  -> /v1.0.0/user/delete-users (token,admin)

V. CLI usage

1. ct-core init
2. ct-core update
3. ct-core apidoc
4. ct-core start [options]

Options:
  --port, -p     Start app with port
  --host, -h     Start app with host
  --help         Show help                  [boolean]
  --version, -v  Show version number        [boolean]

Examples:
  ct-core init
  ct-core update
  ct-core apidoc
  ct-core start -h localhost -p 3000

https://www.npmjs.com/package/ct-core

VI. Deployment

1. Install software to serve

npm install -g pm2
pm2 startup

2. Copy and edit the environment in the process.json

cp process.json.copy process.json
pm2 start process.json
pm2 save

VII. Build to binary

npm install -g pkg
npm run pack-linux | pack-mac | pack-win

License

MIT