Fun.framework.cli NPM

An awesome CLI for fun.framework.

Install

npm i -g fun.framework.cli

You can also clone this repository locally and link the binaries.

git clone https://github.com/neuralgeeks/fun.framework.cli.git
// OR
git clone git@github.com:neuralgeeks/fun.framework.cli.git
cd fun.framework.cli
npm install
npm link

Usage

You can ask for help with:

fun.cli -h

The CLI currently has 3 generation features: project generation (aka. Init), service generation and resource generation (aka. RESTful entity generation).

Project generation

This command inits a fun.framework project. Some promts will be shown so that the CLI knows how to generate the best base project.

fun.cli init

Service generation

This command generates a service inside a fun.framework project. It will generate all the folder and file structure that you need to start using a new service in your project.

fun.cli generate:service

Resource generation

This command generates a RESTful resource inside a fun.framework project. You can select the service that will serve the new resource. You can also choose which parts of the resource files you want to generate, by default the controller, the model, the repository, the REST validators, the routes file, the transform and the testing specs are generated.

fun.cli generate:resource

About schematics

This project uses Angular schematics as the core of file system manipulation. Please show support to the awesome Angular.io community for making such reliable caffolding library.

Run tests

The test are currently in development 🛠 and will be available for the next major version 👀. Please stay tune for updates ⌚️.

npm install
npm run test

Author

👤 neuralgeeks

🤝 Contributing

Contributions, issues and feature requests are welcome 👍🏻. Feel free to check our issues page. Our community just started! We are doing our absolute best to make this project the best, that is why we are taking our time to stablish the contributing methodology, an in-depth contributing guide will be available soon, we are taking our time so that the project's contribution environment is the best posible. Keep in mind this is our first open source project, this means we are still learning how things are done, we want to do this as best as we can! If you really want to help us through this process, contact us at contact@neuralgeeks.com, we are waiting for you!