README.md 87 lines (64 with data), 2.5 kB
ERROR! The markdown supplied could not be parsed correctly. Did you forget to surround a code snippet with "~~~~"?
# generator-vfos-io [![NPM version][npm-image]][npm-url] [![Build Status][travis-image]][travis-url] [![Dependency Status][daviddm-image]][daviddm-url] ## Development vf-OS IO Toolkit Component generator. This generator has been generated using the Yeoman Generator-Generator. If you want to generate the code from scratch, then install Yeoman and the Loopback generator: ```bash npm install -g yo generator-loopback ``` The generator source is under the generator folder. The Swagger default Driver and API Connector files are in the Swagger folder. ## Installation and testing To test it: Install required dependencies (npm install) ```bash npm install -g generator-vfos-io ``` CD to the generator folder: ``` cd generator-vfos-io ``` Link the generator so that you can use it from the command window ``` npm link ``` Generate your new project with the yeoman command tool: ```bash yo vfos-io ``` You can use the option loopback to create a IO component using the loopback framework ```bash yo vfos-io --loopback ``` The option force will overwrite files by default ```bash yo vfos-io --loopback --force ``` ## Using Docker To use the provided Docker file, just find a suitable name for your container image: ```bash docker build -t vfos/vfos-io . ``` The image creates a volume on the folder /home/vfos/generated, which is also the Docker working directory. To access the generated code mount the volume on a folder in your host: On windows ```bash docker run -v e:/workspace/dockers/driver-test2/generated:/home/vfos/generated -it vfos/vfos-io bash ``` On linux ```bash docker run -v /home/user_name/driver-test2/generated:/home/vfos/generated -it vfos/vfos-io bash ``` Make sure that the selected folder in the host machine has create and write permissions to other users group or vfos group. ## Getting To Know Yeoman * Yeoman has a heart of gold. * Yeoman is a person with feelings and opinions, but is very easy to work with. * Yeoman can be too opinionated at times but is easily convinced not to be. * Feel free to [learn more about Yeoman](http://yeoman.io/). ## License MIT © [Francisco]() [npm-image]: https://badge.fury.io/js/generator-vfos-io.svg [npm-url]: https://npmjs.org/package/generator-vfos-io [travis-image]: https://travis-ci.org//generator-vfos-io.svg?branch=master [travis-url]: https://travis-ci.org//generator-vfos-io [daviddm-image]: https://david-dm.org//generator-vfos-io.svg?theme=shields.io [daviddm-url]: https://david-dm.org//generator-vfos-io