floca-cli

FLOCA-CLI

floca-cli is a command line toolset to leverage the services of floca.

Features

Generates

• floca projects
• business entities
• service functions
• complete interaction between entities

Installation

$ npm install -g floca-cli

Quick setup

Using the CLI tool:

$ floca create demoApp
$ cd demoApp
$ npm install
$ npm start

The CLI tool will create a new folder 'demoApp', and will create all required subfolders and files in it. By executing those npm commands, your microservice is ready-to-serve! The initial project will contain:

• a microservice
• a Starter code
• a preliminary package.json
• a sample config for the microservices

Create Project

To create a new project execute the following:

$ floca-cli create project <projectName> [--amqp] [--mqtt] [--nsq] [--web] [--gulp] [--force]

This will create a folder projectName inside the execution folder and creates a minimal viable floca project using the transport provider you might pass. The project can be used right away:

$ npm install
$ npm start

You can tell floca to generate code for a web server if your project aims to serve pages. Gulp is also an project creational option if you need Gulp build scripts for your project.

Extend the bus folder with entities and have a happy coding!

Create Entity

From the your floca working folder, you can create an Entity by CLI:

$ floca-cli create entity <entityName> [--rest] [--websocket]

This will create a business entity JS file inside your 'bus' folder optionally with REST and/or Websocket ports opened.

Create Service

You can add service functions to your entities as shown below:

$ floca-cli create service <entityName> <serviceName>

The JS file identified by the "serviceName" will be opened and a JS floca function will be added to with the name "serviceName".

You can address other entities from there in respect your business flow.

Generate Test Mocha code

If your project possesses the service entities you might want to use, the CLI tool can generate Mocha tests for them:

$ floca-cli generate test --mocha

This will execute a floca instance and all entities providing REST or Websocket interface will be associated with a test case.

All code will be put to the file: test/mochaTest

Execute this statement to call mocha on tests:

$ mocha test/mochaTest

Tests are generated with always accept behavior waiting for being unfold.

License

(The MIT License)

Copyright (c) 2016 Upwards Motion Ltd (1st Floor, 2 Woodberry Grove, Finchley, London N12 0DR; Company Registration No: 09074890)

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Bugs

See https://github.com/UpwardsMotion/floca-cli/issues.