@cowlingj/generator-ecommerce-backend-service

generator-ecommerce-backend-service

Installation

Then install Yeoman and @cowlingj/generator-ecommerce-backend using npm (we assume you have pre-installed node.js).

npm install -g yo
npm install -g @cowlingj/generator-ecommerce-backend-service

Then generate files using one of the subgenerators:

yo @cowlingj/ecommerce-backend-service:<sub-generator>

Sub Generators

docs

The docs generator generates a docs directory containing helm and app markdown documentation using the following files:

• app/package.json
• app/.env.sample
• app/.nvmrc
• chart/chart-name/Chart.yaml
• chart/chart-name/values.yaml

Doc comments can be provided in app/.env.sample and chart/chart-name/values.yaml files to add descriptions for configuration. The format for a doc commant should be ## key: value, no support exists for multiline comments.

For helm values the key is the flattened value key e.g.

parent:
  child:
    - key: value

is parent.child.0.key

minimal-service

The minimum-service generator produces the expected layout for a service, with as little files as possible. Created structure:

/
|- app/
|  |- .gitkeep
|- chart/
   |- <CHART NAME>/
      |- Chart.yaml

graphql-service

The graphql-service generator produces the full recommended layout for a service including github workflows, appollo server, docker image, and helm chart.

/
|- .github/workflows/
   |- <app-id>-tests.yaml
   |- <app-id>-docker.yaml
   |- <app-id>-docs.yaml
|- path/to/service/
   |- app/ : node application
   |- chart/
      |- <CHART NAME>/ : helm chart