easybk-cli
v1.0.6
Published
CLI to create a quick backend template based on ExpressJS
Downloads
5
Maintainers
Readme
EasyBK CLI - A tool for BK Template
EasyBK is a quick tool to generate a simple ExpressJS template to start large projects.
Installation
npm i -g easybk-cli
Quick Start
Once the EasyBK CLI is installed you can use
easybk
Which will allow you to access the CLI commands, currently the demo version only has these commands:
| Commands |
| :------ |
| new
|
| generate
|
To create a new project just use
easybk new
Complete the different fields of the installation and once finished the CLI will begin to install all the basics of the template.
Command: New
This command requires 5 attributes to complete, 3 of these do not need to be filled in.
Name - Name of the project and the containing folder
Hostname - Name of the host to host the server
Port - Server hosting port
CORS Route - Route allowed by the server's CORS (Read documentation about CORS in ExpressJS)
Open with - To confirm the opening with Visual Studio Code (installation required)
Command: Generate
Notice: Currently this command only generates new components, in a future version it will be able to generate services to be injected independently into each component
The command requires to be executed in an EasyBK project since it depends on the easybk.json file (read final) and requires 2 fields to continue.
Action - Choose what you will create with the generate command (read notice)
Name - Enter the name of the object to create.
The easybk.json file contains information that helps the CLI complete certain activities, not modify lines that have explicitly written instructions.