# generator-restify

> Create a restify based RESTful API, with grunt and a linter (jshint or jslint)

Latest version **0.2.0** (published 2016-05-18) · MIT license · 0 weekly downloads

## Install

```sh
npm install generator-restify
pnpm add generator-restify
yarn add generator-restify
bun add generator-restify
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.2.0 |
| Published | 2016-05-18 |
| First published | 2015-04-27 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=0.10.0 |
| Dependencies | 2 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 16 |
| Author | Christopher luna |
| Maintainers | chris-l |
| Keywords | yeoman-generator, restify, grunt, jshint, jslint |

## Links

- npm: https://www.npmjs.com/package/generator-restify
- Repository: https://github.com/chris-l/generator-restify
- Homepage: https://github.com/chris-l/generator-restify#readme
- Issues: https://github.com/chris-l/generator-restify/issues
- npm.io page: https://npm.io/package/generator-restify

## Dependencies (2)

- [chalk](https://npm.io/package/chalk.md) ~0.4.0
- [yeoman-generator](https://npm.io/package/yeoman-generator.md) ~0.16.0

## Alternatives

- [eslint-plugin-sonarjs](https://npm.io/package/eslint-plugin-sonarjs.md) — 2.9M weekly downloads
- [eslint-config-expo](https://npm.io/package/eslint-config-expo.md) — 1.5M weekly downloads
- [@matter/protocol](https://npm.io/package/@matter/protocol.md) — 63.5K weekly downloads
- [@eventcatalog/linter](https://npm.io/package/@eventcatalog/linter.md) — 24.8K weekly downloads
- [@pandacss/eslint-plugin](https://npm.io/package/@pandacss/eslint-plugin.md) — 18.7K weekly downloads

## Recent versions

- 0.2.0 (latest) — 2016-05-18
- 0.1.2 — 2015-12-15
- 0.1.1 — 2015-06-30
- 0.1.0 — 2015-04-27

## README

# generator-restify [![Build Status](https://secure.travis-ci.org/chris-l/generator-restify.png?branch=master)](https://travis-ci.org/chris-l/generator-restify)

A yeoman generator that will create the boilerplate for creating a [restify](http://mcavage.me/node-restify/) based RESTful API.

It uses [npm scripts](https://docs.npmjs.com/misc/scripts) as the task runner. It also allows to choose between [jslint](http://www.jslint.com) or [jshint](http://jshint.com).

## About the folder structure

One of the most relevant parts of this generator is the auto-inclusion of files.

To create a new route, is only necessary to create a file in the `routes/` directory that looks like this:

```
module.exports = function (server) {
  server.get('/info/:param', function (req, res, next) {
  });

  server.put('/info/', function (req, res, next) {
  });
};
```

Just for being in the `routes` directory, the file will be automatically included. Is not necessary to do any other step.

## Installation

Install: `npm install -g generator-restify`

Create a new directory and enter inside of it:
```
mkdir some-app && cd some-app
```

Run the generator: 
```
yo restify
```


## License

MIT

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