https://github.com/arsevo/restify-gen
https://github.com/arsevo/restify-gen
api api-generator api-server
Last synced: about 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/arsevo/restify-gen
- Owner: ARSevo
- License: mit
- Created: 2018-01-26T05:02:57.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2022-01-15T02:12:48.000Z (over 4 years ago)
- Last Synced: 2025-03-14T21:05:51.120Z (about 1 year ago)
- Topics: api, api-generator, api-server
- Language: JavaScript
- Homepage: https://itnext.io/restify-gen-4e140ec346d2
- Size: 112 KB
- Stars: 5
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[![NPM Version][npm-image]][npm-url]
[![NPM License][npm-license]][npm-url]
[npm-image]: https://img.shields.io/badge/restify--gen-1.0.10-blue.svg
[npm-url]: https://www.npmjs.com/package/restify-gen
[npm-license]: https://img.shields.io/badge/license-MIT-blue.svg
## Installation
```sh
$ npm install -g restify-gen
```
## Quick Start
The quickest way to get started with restify-gen is to utilize the executable `restify-gen` to generate an api application as shown below:
Create the app:
```bash
$ restify-gen myappfolder
```
Install dependencies:
```bash
$ cd myappfolder
$ npm install
```
Start your app at `http://localhost:8080/`:
```bash
$ npm start
```
## Command Line Options
This generator can also be further configured with the following command line flags.
Usage: restify-gen [options] applicationfolder
Options:
-V, --version output the version number
-n, --appname api application name (default )
-d, --appdescription api application description (default My API Description)
-v, --apiversion api version (default 1.0.0)
-p, --port api port (default 8080)
-c, --clustered include cluster application file (clustered.js)
-f, --force clear contents of the application folder if exists
-h, --help output usage information
## License
[MIT](LICENSE)