A Yeoman generator for a Feathers application
JavaScript HTML

README.md

generator-feathers

Build Status

A Yeoman generator for a Feathers application

Installation

First you need install yeoman.

npm install -g yo

Then install the feathers generator.

npm install -g yo generator-feathers

Usage

Create a directory for your new app.

mkdir my-new-app; cd my-new-app/

Generate your app and follow the prompts.

yo feathers

Start your brand new app! 💥

npm start

Available commands

# short alias for generate new application
yo feathers

# generate new application
yo feathers:app

# generate new hook
yo feathers:hook

# generate new middleware
yo feathers:middleware

# generate new model
yo feathers:model

# generate new service
yo feathers:service

Contributing

To contribute PRs for these generators, you will need to clone the repo then inside the repo's directory, run npm link. This sets up a global link to your local package for running tests (npm test) and generating new feathers apps/services/hooks/etc.

When finished testing, optionally run npm uninstall generator-feathers to remove the link.

Changelog

0.8.1

  • adding disableNotifyUpdate config option to generator

0.7.0

  • updating to feathers-authentication@0.7.0
  • automatically setting idField
  • adding restrictToOwner hook to user service

0.6.0

  • adding middleware generation
  • adding auth hooks
  • moving to AST instead of Regex
  • a bunch of bug fixes and improvements

0.5.0

  • bug fixes and improvements
  • making nedb the default db
  • updating error handler

0.4.0

  • removing a bunch of boilerplate

0.3.0

  • sorting out hook path and inclusion
  • changing directory structure

0.2.0

  • cors
  • basic local auth
  • ability to select dbs

0.1.0

  • Initial release

License

Copyright (c) 2015

Licensed under the MIT license.