https://github.com/darlanmendonca/generator-nude

A generator to scaffolding HTTP API's, with Express.js and es6
https://github.com/darlanmendonca/generator-nude

chai eslint express istanbul

Last synced: 4 days ago
JSON representation

A generator to scaffolding HTTP API's, with Express.js and es6

• Host: GitHub
• URL: https://github.com/darlanmendonca/generator-nude
• Owner: darlanmendonca
• License: mit
• Created: 2016-03-07T14:33:12.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2024-07-12T09:53:26.000Z (3 months ago)
• Last Synced: 2024-09-08T09:09:06.150Z (20 days ago)
• Topics: chai, eslint, express, istanbul
• Language: JavaScript
• Homepage:
• Size: 116 KB
• Stars: 16
• Watchers: 3
• Forks: 2
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![Build Status](https://travis-ci.org/darlanmendonca/generator-nude.svg)](https://travis-ci.org/darlanmendonca/generator-nude) 

[![Coverage Status](https://coveralls.io/repos/darlanmendonca/generator-nude/badge.svg?branch=master&service=github)](https://coveralls.io/github/darlanmendonca/generator-nude?branch=master)

[![npm version](https://badge.fury.io/js/generator-nude.svg)](https://badge.fury.io/js/generator-nude)

[![MIT Licence](https://badges.frapsoft.com/os/mit/mit.svg?v=103)](https://opensource.org/licenses/mit-license.php)

A generator to scaffolding HTTP API's, with Express.js and es6

### Offers

- authentication with jwt (using [jsonwebtoken](https://www.npmjs.com/package/jsonwebtoken))

- lint scripts (with [ESLint](http://eslint.org/))

- auto documentation (with [API Docs](http://apidocjs.com/))

- automated tests (with [Mocha](https://mochajs.org/), [Chai](http://chaijs.com/), and [Chai-http](http://chaijs.com/plugins/chai-http/))

- coverage tests (with [Istambul](https://gotwarlost.github.io/istanbul/))

### Requirements

This generator, is a yeoman generator, and require following modules:

- yo

- gulp

To install these:

```sh

npm i -g yo gulp

```

### Install and use

First install this module as global

```sh

npm i -g generator-nude

```

And to use, go to a empty folder, where you want generate project, and run:

```sh

yo nude

```

or

```sh

yo nude nameProject

```

After install dependencies, running your project using default task on Gulp, running:

```sh

gulp

```

and to run tests

```sh

npm test

```