1.0.0 • Published 8 years ago

generator-elasticio v1.0.0

Weekly downloads
-
License
Apache-2.0
Repository
github
Last release
8 years ago

generator-elasticio NPM version Build Status Dependency Status

elastic.io component generator

Installation

First, install Yeoman and generator-elasticio using npm (we assume you have pre-installed node.js).

npm install -g yo
npm install -g generator-elasticio

Then generate your new project:

yo elasticio

Usage

yo elasticio

Note that this template will generate create a new directory in your current directory, so no files will be overwritten or modified.

This will generate a new Node project with following content:

  • Filled package.json file as part of your NPM module
  • .gitignore with defaults for node.js project
  • component.json file with basic structure and simple credentials
  • README.md will give you some inspiration
  • logo.png that will be randomly generated
  • Travis CI continuous integration (optional)
  • License

After that you can just go to the newly generated directory, add it to git and push it to elastic.io (don't forget to create a repo on elastic.io before)

cd my-api-component
git init .
git add *
git commit -a -m 'Initial import'
git remote add elasticio team@git.elastic.io:repository-name.git
git push elasticio master

Subgenerators

Component Action

You can easily scaffold necessary files for a component's action, just use following command inside the component's directory

yo elasticio:action

License

Apache-2.0 © elastic.io GmbH