Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ivanhuay/generator-hiroki
create a REST api faster than ever
https://github.com/ivanhuay/generator-hiroki
api express hiroki mongoose rest yeoman
Last synced: 2 months ago
JSON representation
create a REST api faster than ever
- Host: GitHub
- URL: https://github.com/ivanhuay/generator-hiroki
- Owner: ivanhuay
- License: mit
- Created: 2018-12-12T12:18:34.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2024-06-18T01:42:57.000Z (6 months ago)
- Last Synced: 2024-10-10T21:59:52.010Z (3 months ago)
- Topics: api, express, hiroki, mongoose, rest, yeoman
- Language: JavaScript
- Homepage: https://ivanhuay.github.io/hiroki/
- Size: 696 KB
- Stars: 2
- Watchers: 1
- Forks: 1
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# generator-hiroki [![NPM version][npm-image]][npm-url] [![Build Status][travis-image]][travis-url] [![Dependency Status][daviddm-image]][daviddm-url]
> Generate Rest api using hiroki
## Installation
First, install [Yeoman](http://yeoman.io) and generator-hiroki using [npm](https://www.npmjs.com/) (we assume you have pre-installed [node.js](https://nodejs.org/)).
```bash
npm install -g yo
npm install -g generator-hiroki
```
Then generate your new project:
```bash
yo hiroki
```
### Generate model
Also you can generate a new model in proyect:
```bash
yo hiroki:model
```
### Generate decorator
```
yo hiroki:decorator
```
## 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
│ └── user.js
└── routes
├── auth.js
├── extract-jwt.js
├── home.js
├── index.js
└── users.js
```
* configuration:
```
config/
└── public.js
.env
```
## 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](http://yeoman.io/).
## Hiroki Documentation
[Documentation here](https://ivanhuay.github.io/hiroki/)
## License
MIT © [percho]()
[npm-image]: https://badge.fury.io/js/generator-hiroki.svg
[npm-url]: https://npmjs.org/package/generator-hiroki
[travis-image]: https://travis-ci.org/ivanhuay/generator-hiroki.svg?branch=master
[travis-url]: https://travis-ci.org/ivanhuay/generator-hiroki
[daviddm-image]: https://david-dm.org/ivanhuay/generator-hiroki.svg?theme=shields.io
[daviddm-url]: https://david-dm.org/ivanhuay/generator-hiroki