@specialblend/generator-node

Yeoman generator for Node.js projects (node module, Docker microservice, AWS Lambda) with latest babel, rollup, jest, eslint, travis-ci, terraform

Usage no npm install needed!

<script type="module">
  import specialblendGeneratorNode from 'https://cdn.skypack.dev/@specialblend/generator-node';
</script>

README

@specialblend/generator-node

Yeoman generator for Node.js projects (node module, Docker microservice, AWS Lambda) with latest babel, rollup, jest, eslint, travis-ci, terraform

Installation

  • Make sure you have yo installed: npm install -g yo

  • Install this generator: npm install -g @specialblend/generator-node

  • Clone an empty repo, create a new directory or cd into existing project

  • From inside project root, run yo @specialblend/node

:warning: For existing projects, package.json will be modified:

 conflict package.json
? Overwrite package.json? overwrite

Templates

node (default): node.js module

yo @specialblend/node:module

  • Latest babel, rollup, jest, eslint, travis-ci
  • Preset npm scripts: test, coverage, lint, build
  • Preset TravisCI configuration (.travis.yml)

docker: node.js Docker microservice

yo @specialblend/node:docker

  • Latest babel, rollup, jest, eslint, travis-ci
  • Preset Dockerfile and docker-compose.yml
  • Preset npm scripts: test, coverage, lint, build, start
  • Preset TravisCI configuration (.travis.yml)

lambda: node.js AWS Lambda stack

yo @specialblend/node:lambda

  • Latest babel, rollup, jest, eslint, travis-ci, terraform
  • Preset npm scripts: test, coverage, lint, build, deploy
  • Preset Terraform configuration (terraform.tf)
  • Preset TravisCI configuration (.travis.yml)
  • :warning: This template will prompt for AWS account ID and existing S3 bucket for storing Terraform remote state
  • :warning: npm run deploy requires terraform to be installed