https://github.com/feathersjs-ecosystem/generator-feathers-plugin

A Yeoman generator for creating a FeathersJS plugin.
https://github.com/feathersjs-ecosystem/generator-feathers-plugin

Last synced: 3 months ago
JSON representation

A Yeoman generator for creating a FeathersJS plugin.

• Host: GitHub
• URL: https://github.com/feathersjs-ecosystem/generator-feathers-plugin
• Owner: feathersjs-ecosystem
• License: mit
• Archived: true
• Created: 2014-02-15T16:24:32.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2021-08-16T23:19:08.000Z (about 3 years ago)
• Last Synced: 2024-05-18T21:55:44.950Z (6 months ago)
• Language: JavaScript
• Homepage: https://github.com/feathersjs/feathers
• Size: 154 KB
• Stars: 22
• Watchers: 8
• Forks: 6
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: .github/contributing.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-feathersjs - generator-feathers-plugin - feathers-logo.png) (Plugins / Utilities)

README

        
# generator-feathers-plugin

A [Yeoman](http://yeoman.io) generator for initializing new [Feathersjs](https://github.com/feathersjs) plug-ins.

## Getting Started

To install [generator-feathers-plugin](https://github.com/feathersjs/generator-feathers-plugin) from [npm](https://www.npmjs.org/), 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](https://mochajs.org/) test runner and the [Chai](http://chaijs.com/) 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](http://en.wikipedia.org/wiki/MIT_License)