# @gorillab/create-micro

> Microservices based on zeit/micro generator

Latest version **1.3.0** (published 2018-03-09) · MIT license · 0 weekly downloads

## Install

```sh
npm install @gorillab/create-micro
pnpm add @gorillab/create-micro
yarn add @gorillab/create-micro
bun add @gorillab/create-micro
```

Provides the command `create-micro`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.3.0 |
| Published | 2018-03-09 |
| First published | 2017-12-05 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=9 |
| Dependencies | 7 |
| Unpacked size | 125.2 KB |
| Known vulnerabilities | 0 (+2 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Gorillab |
| Maintainers | khanghuynh92, phatpham9 |
| Keywords | micro, zeit, microservice, gorillab, http, https |

## Links

- npm: https://www.npmjs.com/package/@gorillab/create-micro
- Repository: https://github.com/gorillab/create-micro
- Homepage: https://github.com/gorillab/create-micro#readme
- Issues: https://github.com/gorillab/create-micro/issues
- npm.io page: https://npm.io/package/@gorillab/create-micro

## Dependencies (7)

- [args](https://npm.io/package/args.md) 2.6.0
- [chalk](https://npm.io/package/chalk.md) 1.1.3
- [trash](https://npm.io/package/trash.md) ^4.0.1
- [shelljs](https://npm.io/package/shelljs.md) 0.7.7
- [mustache](https://npm.io/package/mustache.md) 2.3.0
- [camelcase](https://npm.io/package/camelcase.md) ^4.1.0
- [recursive-readdir](https://npm.io/package/recursive-readdir.md) 2.1.1

## Recent versions

- 1.3.0 (latest) — 2018-03-09
- 1.2.3 — 2018-01-14
- 1.2.2 — 2017-12-16
- 1.2.1 — 2017-12-10
- 1.2.0 — 2017-12-05

## README

# create-micro
Microservices based on [zeit/micro](https://github.com/zeit/micro) generator


## Installation

Install using [yarn](https://yarnpkg.com/en/):
```
$ 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](https://github.com/zeit/micro) and [micro-dev](https://github.com/zeit/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`.*

---
_Source: https://npm.io/package/@gorillab/create-micro · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._