# generator-feathers-namespace

> A Yeoman generator for a Feathers application

Latest version **3.1.1** (published 2018-03-28) · MIT license · 0 weekly downloads

## Install

```sh
npm install generator-feathers-namespace
pnpm add generator-feathers-namespace
yarn add generator-feathers-namespace
bun add generator-feathers-namespace
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 3.1.1 |
| Published | 2018-03-28 |
| First published | 2018-03-28 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >= 6.0.0 |
| Dependencies | 6 |
| Unpacked size | 379.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Feathers contributors |
| Maintainers | richbai90 |
| Keywords | feathers, feathers-plugin, feathers-app-generator, yeoman-generator, yeoman |

## Links

- npm: https://www.npmjs.com/package/generator-feathers-namespace
- Repository: https://github.com/richbai90/generator-feathers
- Issues: https://github.com/richbai90/generator-feathers/issues
- npm.io page: https://npm.io/package/generator-feathers-namespace

## Dependencies (6)

- [lodash](https://npm.io/package/lodash.md) ^4.17.4
- [semver](https://npm.io/package/semver.md) ^5.4.1
- [randomstring](https://npm.io/package/randomstring.md) ^1.1.5
- [yeoman-generator](https://npm.io/package/yeoman-generator.md) ^2.0.0
- [@feathersjs/tools](https://npm.io/package/@feathersjs/tools.md) ^0.1.0
- [@feathersjs/jscodeshift](https://npm.io/package/@feathersjs/jscodeshift.md) ^0.5.0

## Alternatives

- [@fortawesome/react-fontawesome](https://npm.io/package/@fortawesome/react-fontawesome.md) — 2.2M weekly downloads
- [roboto-fontface](https://npm.io/package/roboto-fontface.md) — 196.0K weekly downloads
- [@react-native-vector-icons/common](https://npm.io/package/@react-native-vector-icons/common.md) — 150.4K weekly downloads
- [@procore/core-icons](https://npm.io/package/@procore/core-icons.md) — 4.6K weekly downloads
- [@react-md/material-icons](https://npm.io/package/@react-md/material-icons.md) — 1.6K weekly downloads

## Recent versions

- 3.1.1 (latest) — 2018-03-28
- 3.1.0 — 2018-03-28

## README

# generator-feathers

[![Greenkeeper badge](https://badges.greenkeeper.io/feathersjs/generator-feathers.svg)](https://greenkeeper.io/)

[![Build Status](https://travis-ci.org/feathersjs/generator-feathers.png?branch=master)](https://travis-ci.org/feathersjs/generator-feathers)

> A Yeoman generator for a Feathers application. This is a fork of the generator-feathers that places services namespaced with a . on their own url instead of the root url. I.E. yo feathers:service foo.bar would create the following endpoint: /foo/bar It would also place bar as a service within a foo parent directory

## 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-namespace
```

## 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).

---
_Source: https://npm.io/package/generator-feathers-namespace · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._