node package manager
We need your input. Help make JavaScript better: Take the 2017 JavaScript Ecosystem survey ยป

generator-feathers-plugin

generator-feathers-plugin Build Status

Greenkeeper badge

Build Status Dependency Status Download Status Slack Status

A Yeoman generator for initializing new Feathersjs plug-ins.

Getting Started

To install generator-feathers-plugin from npm, run:

$ npm install -g generator-feathers-plugin

Finally, initiate the generator:

$ yo feathers-plugin

This will generate a standard plug-in scaffold with a basic example app that you should modify accordingly to suit your plug-in.

Writing Your Plug-in

We follow proper semantic versioning. That means breaking changes are major releases. Your module version should be < 1.0 until you feel that it is ready for for production.

Feel free to add modules as you see fit but remember that less is more.

Please add tests for your modules and write your code using ES6 syntax.

Running Tests

Simply run npm test.

Tests use the Mocha test runner and the Chai assertion library. We use the expect syntax.

Publishing

The package.json file has helpful scripts to publish your package, tag it, and push it up to production. Please use those.

License

MIT License