gb

generator-baucis

Awesome Baucis api generator.

Showing:

Popularity

Downloads/wk

19

Maintenance

No Maintenance Data Available

Package

Dependencies

3

License

MIT

Type Definitions

Tree-Shakeable

No?

Categories

Readme

generator-baucis NPM version Build Status Dependency Status

Awesome Baucis api generator.

Installation

First, install Yeoman and generator-baucis using npm (we assume you have pre-installed node.js).

sudo npm i -g yo generator-baucis

Then generate your new project:

yo baucis

Getting To Know Yeoman

  • Yeoman has a heart of gold.
  • Yeoman is a person with feelings and opinions, but is very easy to work with.
  • Yeoman can be too opinionated at times but is easily convinced not to be.
  • Feel free to learn more about Yeoman.

About the structure

  • The logic of your application should be contained in these folders:
lib/
├── decorators
│   ├── index.js
│   └── user.js
├── logger.js
├── models
│   ├── index.js
│   ├── schemas
│   │   └── user-schema.js
│   └── user.js
└── routes
    ├── auth.js
    ├── extract-jwt.js
    ├── home.js
    ├── index.js
    └── users.js
  • configuration:
config/
└── public.js
.env

Custom routes, decorators models

in each folder we can add new files but they must be exported in the index.js and match the decorator name with the mongoose models

Examples

by default the generator provides sample files: models, decorators and custom routes

Support

Node v4 or higger

Changelog

  • v0.1.5 - bugfix auth route and favico, update mongoose connection.
  • v0.1.0 or higger support jwt validation.
  • v0.2.1 update yeoman generator, bugfix and remove unnecessary dependencies

License

MIT © ivanhuay

Rate & Review

Great Documentation0
Easy to Use0
Performant0
Highly Customizable0
Bleeding Edge0
Responsive Maintainers0
Poor Documentation0
Hard to Use0
Slow0
Buggy0
Abandoned0
Unwelcoming Community0
100