https://github.com/felipefialho/generator-kratos-boilerplate
Yeoman generator for Kratos Boilerplate.
https://github.com/felipefialho/generator-kratos-boilerplate
boilerplate kratos pug stylus webpack yeoman yeoman-generator
Last synced: 3 months ago
JSON representation
Yeoman generator for Kratos Boilerplate.
- Host: GitHub
- URL: https://github.com/felipefialho/generator-kratos-boilerplate
- Owner: felipefialho
- License: mit
- Created: 2018-07-18T17:53:19.000Z (almost 7 years ago)
- Default Branch: main
- Last Pushed: 2020-12-02T21:26:32.000Z (over 4 years ago)
- Last Synced: 2025-01-31T10:35:49.443Z (4 months ago)
- Topics: boilerplate, kratos, pug, stylus, webpack, yeoman, yeoman-generator
- Language: JavaScript
- Homepage: https://github.com/felipefialho/kratos-boilerplate
- Size: 146 KB
- Stars: 7
- Watchers: 3
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# generator-kratos-boilerplate
Generated by [OSS Project Generator](http://bit.ly/generator-oss-project).
[](https://github.com/felipefialho/kratos-boilerplate/graphs/contributors)
[![NPM Version][npm-badge]][npm-url]
[![License][license-badge]][license-url]
> Yeoman generator for Kratos Boilerplate.
Long description.
## Installation
Install package
```bash
$ npm install --save generator-kratos-boilerplate
```
## Usage
Say `It works!`
```js
const lib = require('generator-kratos-boilerplate');
lib.hello((err, message) => {
if (err) return console.error(err);
console.log(message);
});
```
## Development
- Cloning the repo
```bash
$ git clone https://github.com/felipefialho/generator-kratos-boilerplate.git
```
- Installing dependencies
```bash
$ npm install
```
- Running scripts
| Action | Usage |
| ---------------------------------------- | ------------------- |
| Starting development mode | `npm start` |
| Linting code | `npm run lint` |
| Running unit tests | `npm run jest` |
| Running code coverage | `npm run coverage` |
| Running lint + tests | `npm test` |
| Sending coverage results to Coveralls.io | `npm run coveralls` |
## Author
- [Roberto Achar](https://twitter.com/robertoachar)
- [Felipe Fialho](https://twitter.com/felipefialho_)
## License
[MIT](https://github.com/felipefialho/generator-kratos-boilerplate/blob/master/LICENSE)
[npm-badge]: https://img.shields.io/npm/v/generator-kratos-boilerplate.svg
[npm-url]: https://www.npmjs.com/package/generator-kratos-boilerplate
[license-badge]: https://img.shields.io/github/license/felipefialho/generator-kratos-boilerplate.svg
[license-url]: https://opensource.org/licenses/MIT