README

api-chunk

api-chunk
quickstart
Commands

quickstart

$ npm install -g api-chunk
$ api-chunk COMMAND
running command...
$ api-chunk (-v|--version|version)
api-chunk/1.0.2 darwin-x64 node-v12.19.0
$ api-chunk --help [COMMAND]
USAGE
  $ api-chunk COMMAND
...

Commands

api-chunk add [TYPE]
api-chunk help [COMMAND]
api-chunk start [PROJECTNAME]

`api-chunk add [TYPE]`

generate new routes, controllers and a model by specifying a 'type'

USAGE
  $ api-chunk add [TYPE]

DESCRIPTION
  eg. `api-chunk add event`

EXAMPLE
  $ api-chunk add message
  generates a Message model with routes and controllers

See code: src/commands/add.ts

`api-chunk help [COMMAND]`

display help for api-chunk

USAGE
  $ api-chunk help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

`api-chunk start [PROJECTNAME]`

generates a blank api-chunk project

USAGE
  $ api-chunk start [PROJECTNAME]

OPTIONS
  -f, --force
  -h, --help       show CLI help
  -n, --name=name  name to print

EXAMPLE
  $ api-chunk start <PROJECTNAME>
  generates a project folder called <PROJECTNAME>

See code: src/commands/start.ts

TODO: auth api-chunk --auth generates basic auth solution, user models, /register, /login, /logout, /profile routes and controllers

generate /register /login /logout /profile

TODO: postgreSQL TODO: generate from a RAML/YAML file TODO: loads of other things i'll never do

Usage no npm install needed!