Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/feathersjs/generator-feathers
A Yeoman generator for a Feathers application
https://github.com/feathersjs/generator-feathers
Last synced: about 1 month ago
JSON representation
A Yeoman generator for a Feathers application
- Host: GitHub
- URL: https://github.com/feathersjs/generator-feathers
- Owner: feathersjs-ecosystem
- License: mit
- Archived: true
- Created: 2015-10-25T01:02:54.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2023-01-03T21:59:03.000Z (almost 2 years ago)
- Last Synced: 2024-05-18T21:55:39.980Z (6 months ago)
- Language: JavaScript
- Homepage: https://github.com/feathersjs/feathers
- Size: 2.99 MB
- Stars: 121
- Watchers: 9
- Forks: 131
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome-feathersjs - generator-feathers - feathers-logo.png) (Plugins / Utilities)
README
# generator-feathers
> __Important:__ The Feathers generator has been moved to the [cli package](https://github.com/feathersjs/feathers/tree/dove/packages/cli) in [feathersjs/feathers](https://github.com/feathersjs/feathers )
[](https://github.com/feathersjs/generator-feathers/actions?query=workflow%3ACI)
> A Yeoman generator for a Feathers application
## Installation
First you need install [yeoman](http://yeoman.io/).
```bash
npm install -g yo
```
Then install the feathers generator.
```bash
npm install -g yo generator-feathers
```
## Usage
Create a directory for your new app.
```bash
mkdir my-new-app; cd my-new-app/
```
Generate your app and follow the prompts.
```bash
yo feathers
```
Start your brand new app! 💥
```bash
npm start
```
## Available commands
```bash
# short alias for generate new application
yo feathers
# set up authentication
yo feathers:authentication
# set up a database connection
yo feathers:connection
# generate new hook
yo feathers:hook
# generate new middleware
yo feathers:middleware
# generate new service
yo feathers:service
```
## Production
[feathers/feathers-configuration](https://github.com/feathersjs/feathers-configuration) uses `NODE_ENV` to find a configuration file under `config/`. After updating `config/production.js` you can run
```bash
NODE_ENV=production npm start
```
## 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.
## License
Copyright (c) 2017
Licensed under the [MIT license](LICENSE).