Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
saucecodee authored Nov 3, 2020
1 parent 9877591 commit 25141f7
Showing 1 changed file with 61 additions and 1 deletion.
62 changes: 61 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -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

0 comments on commit 25141f7

Please sign in to comment.