Skip to content
A Yeoman generator for creating a FeathersJS plugin.
Branch: master
Clone or download
daffl Unarchive repository and update all dependencies (#55)
* Unarchive repository and update all dependencies

* Update package-lock.json

* Skip client test for now
Latest commit 274bee0 Nov 16, 2018
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github Adding .github folder and templates Oct 22, 2016
app Update plugin generator to correspond with latest release (#49) Jan 4, 2018
test
.editorconfig Updating to latest Yeoman and new plugin infrastructure. Oct 24, 2015
.gitignore Updating .npmignore, adding Slack notifications to Travis file and ba… Oct 26, 2016
.jshintrc Initial generator. Feb 15, 2014
.travis.yml Update yeoman-generator to the latest version 🚀 (#53) Jul 4, 2018
CHANGELOG.md Updating changelog Jan 4, 2018
LICENSE
README.md Unarchive repository and update all dependencies (#55) Nov 16, 2018
package-lock.json Unarchive repository and update all dependencies (#55) Nov 16, 2018
package.json Unarchive repository and update all dependencies (#55) Nov 16, 2018

README.md

generator-feathers-plugin

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

You can’t perform that action at this time.