0.0.2 • Published 7 years ago

franz-init v0.0.2

Weekly downloads
1
License
MIT
Repository
github
Last release
7 years ago

franz-init CircleCI

add franz to your project

Install

$ npm install --save franz-init

Usage

const franzInit = require('franz-init')

const franzFile = {
  service: {
    port: 3000,
    environment: {
      node: 7
    }
  },
  endpoints: {
    'get-users': {
      url: '/get-users',
      method: 'GET'
    }
  }
}

franzInit(franzFile)
// => true

API

franzInit(cwd, options)

Returns a promise

cwd

Type: string Default: process.cwd()

path to create franz.yml

options

Type: object

docker

Type: object Default: false

true if project is using docker.

port

Type: number Default: 3000

environment

Type: number Default: node

version

Type: number Default: 7

License

MIT © Bu Kinoshita