generator-nodeserver

NodeServer Generator

Current State

This is an early version of the nodeserver generator. It produces a simple Expressed-based node.js server that serves up a trivial page and exposes a health endpoint (/health). Additionally, configuration files are generated for the following tools and deployment environments:

1. Docker
2. Kubernetes/Helm
3. Cloud Foundry
4. IBM Cloud Developer Tools

Prompting

The generator presently prompts only for project name and docker registry (i.e. target for IDT's 'bx dev deploy' command). Additional prompting is planned for Swagger as input to direct code generation and IBM Cloud services, including Cloudant, ObjectStore,AppID, and more.

Pre-requisites

Install Yeoman

npm install -g yo

Installation

npm install -g generator-nodeserver

Usage

yo nodeserver 

Development

Clone this repository and link it via npm

git clone https://github.com/ibm-developer/generator-nodeserver
cd generator-nodeserver
npm link

In a separate directory invoke the generator via

yo nodeserver 

Publishing Changes

In order to publish changes, you will need to fork the repository or ask to join the ibm-developer org and branch off the development branch.

Once you are finished with your changes, run npm test to make sure all tests pass.

Do a pull request against development, make sure the build passes. A team member will review and merge your pull request. Once merged to development, the version will be auto-incremented. Do a pull request against master, once that PR is reviewed and merged, a new version will be published to npm.