From 233a32b4e6d122c47c7f6575b1b69d54099ca02f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?I=20F=20E=20DI=20L=20I=20=E2=9A=A1?= Date: Wed, 4 Nov 2020 00:43:42 +0100 Subject: [PATCH] Update README.md --- README.md | 62 ++++++++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 61 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 14e308a..75dc2ed 100644 --- a/README.md +++ b/README.md @@ -1 +1,61 @@ -# BangaJS +[![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] + + +## Installation + +BangaJS is 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/) + +Then install BangaJS globally: + +```bash +$ npm install bangajs -g +``` + +## Features + + * Quick project setup + * Generate Route, controller and Service files with CRUD methods. + +## Docs + + * [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: + +```bash +$ banga new hello-app +``` + + Then navigate into the newly created project and start up the server: + +```bash +$ cd hello-app +$ npm run dev +``` + + By default the server will be running on http://localhost:2020/ + +## People + +The author of BangaJS is [Onyegbu Ifedili](https://github.com/saucecodee) + +[List of all contributors](https://github.com/saucecodee/banga/graphs/contributors) + +## License + + [MIT](LICENSE) + +[npm-image]: https://img.shields.io/npm/v/bangajs.svg +[npm-url]: https://npmjs.com/package/bangajs +[downloads-image]: https://img.shields.io/npm/dm/bangajs.svg +[downloads-url]: https://npmcharts.com/compare/bangajs?minimal=true