BIG-HEAD

An easy Front-End control panel generator for APIed-Piper, and now server generator too.

If you want to know more about APIed-Piper visit: npm APIed-Piper docs

Install:

npm i -g big-head

How to use

Definition file

First you need to create a definition file, this files will help you to construct your server and console. for more information visit the npm APIed-Piper docs to know about definition file

{
  "category": {
    "operation": {
      "all": true
    },
    "definition": {
      "name": {
        "type": "string",
        "mandatory": true
      },
      "active": {
        "type": "boolean",
        "mandatory": true,
        "default": false
      },
      "key": {
        "type": "number"
      }
    },
    "datatable_search_fields": [
      "name"
    ]
  },
  "type": {
    "operation": {
      "all": true
    },
    "definition": {
      "name": {
        "type": "string",
        "mandatory": true
      },
      "active": {
        "type": "boolean",
        "mandatory": true,
        "default": false
      },
      "key": {
        "type": "number"
      }
    },
    "datatable_search_fields": [
      "name"
    ]
  },
  "product": {
    "operation": {
      "all": true
    },
    "definition": {
      "name": {
        "type": "string",
        "mandatory": true
      },
      "description": {
        "type": "string"
      },
      "count": {
        "type": "number",
        "mandatory": true,
        "default": 0
      },
      "type": {
        "type": "oid",
        "rel": "type"
      },
      "category": {
        "type": "oid",
        "rel": "category"
      },
      "moreInfo": {
        "type": "any"
      }
    },
    "datatable_search_fields": [
      "name"
    ]
  }
}

Once you create your definition file, you can create

• A microservice
• B admin console for microservice

Create a microservice server

command

bighead service 

options

 -d, --definition <definition...>  The full file folder and path of definition JSON. Mandatory **
  -l, --location <location...>      The full file folder and path where the project will be created. Default: ./
  -b, --base <base...>              APIed-Piper base path server. Default: /api/
  -p, --port <port...>              Port where Big-Head will run. Default: 3000
  -m, --mdb_uri <mdb_uri...>        The MongoDB URI to store data . Default: mongodb://localhost:27017/apied_piper
  -u, --user <user...>              Admin User by default. Default: PIED
  -pw, --password <password...>     Admin Password by default. Default: HBO_Sillicon33
  -h, --help                        display help for command

Create an admin panel for server

command

bighead console 

options

Options:
  -d, --definition <definition...>  The full file folder and path of definition JSON. Mandatory **
  -l, --location <location...>      The full file folder and path where the project will be created. Default: ./
  -u, --uri <uri...>                APIed-Piper url server. Default:  http://localhost:3000/
  -b, --base <base...>              APIed-Piper base path server. Default: api/
  -p, --port <port...>              Port where Big-Head will run. Default: 3333
  -h, --help                        display help for command

finally enter the folder and run

npm start

or edit the project, in your favourite editor