From 9e94b5ccb5378ff119258e43ec62985d331ce27b Mon Sep 17 00:00:00 2001 From: saucecodee Date: Tue, 3 Nov 2020 23:48:13 +0100 Subject: [PATCH 1/2] chore: update cli help menu --- lib/cmd/help.js | 57 ++++++++++++++++++++++++++++++------------------- package.json | 4 ++-- 2 files changed, 37 insertions(+), 24 deletions(-) diff --git a/lib/cmd/help.js b/lib/cmd/help.js index 3b08c2e..63c5f94 100644 --- a/lib/cmd/help.js +++ b/lib/cmd/help.js @@ -2,7 +2,7 @@ const help = {} help.default = ` -Generate production ready Nodejs application +Build ExpressJS applications with speed and efficiency with BangaJS Usage: @@ -12,18 +12,11 @@ Usage: Commands: - docs\t\t\tOpen the BangaJS documentation website - generate\t\tGenerate and/or modify files - help\t\t\ttLists available commands and options. - new\t\t\tCreates a new workspace and an initial Banga app. - version\t\tShow the BangaJS version information - - -Options: - - -h, --help\t\tLists available commands and options. - -v, --version\t\tShow the BangaJS version information - -f, --force\t\tWhen true, forces overwriting of existing files. + docs\t\t\tOpens Banga docmentation in a browser + generate\t\tGenerates and/or modifies files. + help\t\t\tLists available commands and their descriptions. + new\t\t\tCreates a new Express app. + version\t\tDisplays Banga version. Run 'banga --help' for more information on a command. @@ -40,24 +33,44 @@ Usage: $ banga generate [] -type: +Types: + + a, asset\t\tCreate controller, model, route and service files. + c, controller\t\tCreate controller file + m, model\t\tCreate model file + r, route\t\tCreate route file + s, service\t\tCreate service file + + +Options: + --auth\t\tAdd auth middleware to routes + --no-controller\tDo not create controller file + --no-create\t\tDo not include create methods + --no-crud\t\tDo not include CRUD methods + --no-delete\t\tDo not include delete methods + --force\t\tReplace file if it already exists + --no-model\t\tDo not create model file + --no-read\t\tDo not include read methods + --root\t\tCreates file at the root of the current working directory + --no-route\t\tDo not create route file + --no-service\t\tDo not create service file + --no-update\t\tDo not include update methods - a, asset\t\tOpen the BangaJS documentation website - c, controller\t\tOpen the BangaJS documentation website - m, model\t\tGenerate and/or modify files - r, route\t\tLists available commands and options. - s, service\t\tCreates a new workspace and an initial Banga app. ` help.new = ` -Creates a new workspace and an initial Banga app. - +Creates a new Express app. Usage: - $ banga new [] + $ banga new [] + + +Options: + --force\t\tReplace file if it already exists + --no-auth\t\tDo not include User and authentication files ` diff --git a/package.json b/package.json index 3208174..893d883 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "name": "bangajs", - "version": "0.1.0", - "description": "Generate production ready Nodejs application in no time", + "version": "0.2.0", + "description": "Banga is a CLI generator for building ExpressJS applications with speed and efficiency.", "main": "bin/index.js", "bin": { "banga": "bin/index.js" From 43eb276db4668eb2be25a8733b3906affe944217 Mon Sep 17 00:00:00 2001 From: saucecodee Date: Wed, 4 Nov 2020 00:45:47 +0100 Subject: [PATCH 2/2] docs: update read me --- README.md | 27 +++++++++++++-------------- 1 file changed, 13 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 75dc2ed..2217abc 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,13 @@ [![BangaJS Logo](https://i.ibb.co/qr5jqrk/BangaJS.png)](https://bangajs.netlify.app/) - Banga is a cli generator for building [ExpressJS](https://expressjs.com) applications with speed and efficiency. - - [![NPM Version][npm-image]][npm-url] - [![NPM Downloads][downloads-image]][downloads-url] +BangaJS is a cli generator for building [ExpressJS](https://expressjs.com) applications with speed and efficiency. +[![NPM Version][npm-image]][npm-url] +[![NPM Downloads][downloads-image]][downloads-url] ## Installation -BangaJS is available on the [Node.js](https://nodejs.org/en/) module through the +It's available on the [Node.js](https://nodejs.org/en/) module through the [npm registry](https://www.npmjs.com/). Before installing, [download and install Node.js](https://nodejs.org/en/download/) @@ -21,29 +20,29 @@ $ npm install bangajs -g ## Features - * Quick project setup - * Generate Route, controller and Service files with CRUD methods. +- Quick project setup +- Generate Route, controller and Service files with CRUD methods. ## Docs - * [Website and Documentation](https://bangajs.netlify.app/) +- [Website and Documentation](https://bangajs.netlify.app/) ## Getting started - Now let's create a new Express app named **hello-app**. It would be created in a new folder called **hello-app** in the current working directory: +Now let's create a new Express app **hello-world**. It would be created in a new folder called **hello-world** in the current working directory: ```bash -$ banga new hello-app +$ banga new hello-world ``` - Then navigate into the newly created project and start up the server: +Then navigate into the newly created project and start up the server: ```bash -$ cd hello-app +$ cd hello-world $ npm run dev ``` - By default the server will be running on http://localhost:2020/ +By default the server will be running on http://localhost:2020/ ## People @@ -53,7 +52,7 @@ The author of BangaJS is [Onyegbu Ifedili](https://github.com/saucecodee) ## License - [MIT](LICENSE) +[MIT](LICENSE) [npm-image]: https://img.shields.io/npm/v/bangajs.svg [npm-url]: https://npmjs.com/package/bangajs