scaff-js v0.0.1

Scaff-js

This package is used for scaffolding Node.js applications, with basic packages such as express and nodemon.

Installation

The package is installed as a global package using the command
npm i -g scaff-js

Usage

Scaff-js can then be used in any directory in the bash script to scaffold a project, using the prefix sf, i.e. sf <command> <options>

Commands

Generate new application

sf new <app-name><options>

Options

• Version

  -v | --version <version>
  This specifies the app version. Default is 1.0.0

• Description
  -d | --description <description>
  App description

• Web framework <framework>
  -wf | --web-framework
  Web framework to be used, either express or netlify. Default is "express"

• Server
  -s | --server <server-name>
  Server name to be used. Default is index.js

• Port -p | --port <port>
  Port number the app runs on. Default is 3000

• Nodemon (boolean) -nm | --nodemon
  Specify whether or not to use nodemon as a dev dependency. Default is false. If the flag is included, value will be true

• Author -a | --author <author>
  Name of the author of the project

• GitHub Repo (URL)
  -gh | --github <github-repo-url>
  Project's github URL

• Licence
  -lc | --license <license>
  Licence used. Default is ISC

• Help
  -h | --help
  Display help for command options