create-micro

Microservices based on zeit/micro generator

Installation

Install using yarn:

$ yarn global add @gorillab/create-micro

Usage

Help command

$ create-micro --help

Response:

  Usage: create-micro [options] [command]

  Commands:

    help  Display help

  Options:

    -d, --dockerfile    Include Dockerfile in the project using mhart/alpine-node (disabled by default)
    -h, --help          Output usage information
    -n, --name [value]  Name of the basic micro application (defaults to "micro-service")
    -v, --version       Output the version number

Create a service

$ create-micro -n my-application

Response:

Created!

Installing packages using yarn...
yarn install v0.21.3
[1/4] Resolving packages...
[2/4] Fetching packages...
[3/4] Linking dependencies...
warning "eslint-config-prettier@1.7.0" has unmet peer dependency "eslint@>=3.14.1".
warning "request-promise@4.2.0" has unmet peer dependency "request@^2.34".
warning "request-promise-core@1.1.1" has unmet peer dependency "request@^2.34".
[4/4] Building fresh packages...
Done in 12.03s.

Done!

To create a Dockerfile in your service, use the flag --dockerfile.

$ create-micro --dockerfile -n my-service

Directories

  - src
    - config
      - mysql.js
    - sample.controller.js
    - sample.middleware.js
    - sample.model.js
    - helpers.js
    - index.js
  - .env.example
  - .gitignore
  - package.json
  - Dockerfile (if flag --dockerfile was used)

Packages

By default, is used the last version of micro and micro-dev.

Dockerfile

The default image is the latest version of mhart/alpine-node, and the Dockerfile installs just the production dependencies.

Commands

Just to lint:

$ yarn test

To start the local server:

$ yarn start

To start the production server:

$ yarn serve

Don't forget to set the NODE_ENV environment variable to production.