License: MIT

Language: JavaScript


Build Status Greenkeeper badge

A Yeoman generator for a Feathers application


First you need install yeoman.

npm install -g yo

Then install the feathers generator.

npm install -g yo generator-feathers-ts


Create a directory for your new app.

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

Generate your app and follow the prompts.

yo feathers-ts

Start your brand new app! 💥

npm start

Available commands

# short alias for generate new application
yo feathers-ts

# set up authentication
yo feathers-ts:authentication

# set up a database connection
yo feathers-ts:connection

# generate new hook
yo feathers-ts:hook

# generate new middleware
yo feathers-ts:middleware

# generate new service
yo feathers-ts:service


feathers/feathers-configuration uses NODE_ENV to find a configuration file under config/. After updating config/production.js you can run

NODE_ENV=production npm start


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-ts to remove the link.


Copyright (c) 2017

Licensed under the MIT license.

Project Statistics

Sourcerank 2
Repository Size 1.76 MB
Stars 1
Forks 0
Watchers 0
Open issues 0
Dependencies 864
Contributors 57
Tags 0
Last updated
Last pushed

Top Contributors See all

David Luecke Eric Kryski Ucok Freddy greenkeeper[bot] Marshall Thompson Derek Watson Greenkeeper Eko Eryanto Ray Foss Curtis Cummings claforte Jan Lohage Luke Butler Alfredo Delgado Louis-Michel Couture Anton Kulakov Lauritz Hilsøe Joseph Paul Brandon Bertelsen Arve Seljebu

Packages Referencing this Repo

A Yeoman generator for a Feathers application
Latest release 4.0.0-pre.2-3 - Updated - 1 stars

Something wrong with this page? Make a suggestion

Last synced: 2019-06-19 02:00:09 UTC

Login to resync this repository