Generator BLiP API Kates

Yeoman generator for a API using BLiP and ready to Kubernetes and helm.

File Structure

Assuming your folder is called blip-bot-project. Whatever name you choose will replace all occurrences of that string in the project

1 📁blip-bot-project
2 |__📁charts
3    |__📁blip-bot-project
4    |   |__📁templates
5    |   |   |__📃{_helpers.tpl}
6    |   |   |__📃{autoscale.yaml}
7    |   |   |__📃{deployment.yaml}
8    |   |   |__📃{ingress.yaml}
9    |   |   |__📃{secrets.yaml}
10    |   |   |__📃{service.yaml}
11    |   |__📃{.helmignore}
12    |   |__📃{Chart.yaml}
13    |   |__📃{values.yaml}
14 |__📁src
15    |__📁config // The app config
16    |   |__📃{default.json}
17    |   |__📃{index.js}
18    |   |   |__📃{...}
19    |__📁controllers // The controllers
20    |   |__📃{example-controller.js}
21    |   |__📃{health-check-controller.js}
22    |__📁facades // The facades
23    |   |__📃{blip-facade.js}
24    |   |__📃{example-facade.js}
25    |__📁middlewares // The middlewares
26    |   |__📃{error-middleware.js}
27    |   |__📃{logger-middleware.js}
28    |   |__📃{res-body-middleware.js}
29    |   |__📃{validator-middleware.js}
30    |__📁models // The models
31    |   |__📁errors // The error models
32    |   |   |__📃{bad-request-error.js}
33    |   |   |__📃{index.js}
34    |   |   |__📃{no-content-error.js}
35    |   |__📃{route.js}
36    |__📁providers // The providers
37    |   |__📃{blip-provider.js}
38    |   |__📃{logger-provider.js}
39    |__📁routes // The routes
40    |   |__📃{example-routes.js}
41    |   |__📃{health-check-routes.js}
42    |   |__📃{index.js}
43    |   |__📃{routes.js}
44    |__📁services // The services
45    |   |__📃{blip-service.js}
46    |   |__📃{example-service.js}
47    |__📁validators // The schema validators
48    |   |__📃{example-validator.js}
49    |__📃{app.js} // The app startup config
50    |__📃{server.js}
51|__📁test // The tests
52|   |__📃{example.test.js}
53|   |__📃{health-check.test.js}
54|   |__📃{swagger.test.js}
55|__⚙️.editorconfig
56|__⚙️.eslintignore
57|__⚙️.eslintrc.json
58|__⚙️.gitattributes
59|__⚙️.gitignore
60|__⚙️.prettierrc
61|__⚙️LICENSE
62|__⚙️package.json
63|__⚙️README.md
64|__🐋Dockerfile

Usage

Generate without install Yeoman

1# Create a directory for your project && Change into directory
2$ mkdir my-api-name && cd my-api-name
3
4# Generate a project
5$ npm init yo generator-blip-api-kates

Generate installing Yeoman

• Install Yeoman

1$ npm install -g yo

• Install Generator

1$ npm install -g generator-blip-api-kates

• Creating a project

1# Create a directory for your project && Change into directory
2$ take my-api-name
3# Or
4$ mkdir my-api-name && cd my-api-name
5
6# Generate a project
7$ yo blip-api-kates

• Running project

Action	Usage
Starting development mode	npm start
Linting code	npm run lint
Running unit tests	npm run jest
Running lint + tests	npm test
Running code coverage	npm run coverage
Sending coverage results to Coveralls.io	npm run coveralls

Development

Prerequisites

• Install Node.js
• Install npm
• Install Yeoman CLI

1$ npm install -g yo

Clone the repo

1$ git clone https://github.com/chr0m1ng/generator-blip-api-kates.git

Run generator

1# Change into directory
2$ cd generator-blip-api-kates
3
4# Link generator
5$ npm link
6
7# Run generator
8$ yo blip-api-kates

Author

• Gabriel Santos

This generator was created based on original oss generator created by Roberto Achar .

License

MIT