# @codeekage/nab

> Node.js Typescript Scaffolding

Latest version **1.2.6** (published 2019-06-25) · MIT license · 0 weekly downloads

## Install

```sh
npm install @codeekage/nab
pnpm add @codeekage/nab
yarn add @codeekage/nab
bun add @codeekage/nab
```

Provides the command `nab`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.2.6 |
| Published | 2019-06-25 |
| First published | 2019-06-18 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 5 |
| Unpacked size | 240.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | codeekage |
| Maintainers | codeekage |
| Keywords | nodejs, typescript, express, mongodb, morgan |

## Links

- npm: https://www.npmjs.com/package/@codeekage/nab
- Repository: https://github.com/codeekage/nab
- Homepage: https://github.com/codeekage/nab#readme
- Issues: https://github.com/codeekage/nab/issues
- npm.io page: https://npm.io/package/@codeekage/nab

## Dependencies (5)

- [colors](https://npm.io/package/colors.md) ^1.3.3
- [ts-node](https://npm.io/package/ts-node.md) ^8.3.0
- [inquirer](https://npm.io/package/inquirer.md) ^6.3.1
- [commander](https://npm.io/package/commander.md) ^2.20.0
- [typescript](https://npm.io/package/typescript.md) ^3.5.2

## Alternatives

- [angular-pipes](https://npm.io/package/angular-pipes.md) — 5.6K weekly downloads
- [@ng-web-apis/midi](https://npm.io/package/@ng-web-apis/midi.md) — 2.6K weekly downloads
- [happn-3](https://npm.io/package/happn-3.md) — 1.6K weekly downloads
- [@opensip-cli/lang-go](https://npm.io/package/@opensip-cli/lang-go.md) — 1.2K weekly downloads
- [mongoose-typescript](https://npm.io/package/mongoose-typescript.md) — 85 weekly downloads

## Recent versions

- 1.2.6 (latest) — 2019-06-25
- 1.2.5 — 2019-06-25
- 1.2.4 — 2019-06-24
- 1.2.3 — 2019-06-24
- 1.2.2 — 2019-06-24
- 1.2.1 — 2019-06-24
- 1.2.0 — 2019-06-18
- 1.1.6 — 2019-06-18
- 1.1.5 — 2019-06-18
- 1.1.4 — 2019-06-18
- 1.1.3 — 2019-06-18
- 1.1.2 — 2019-06-18
- 1.1.1 — 2019-06-18
- 1.1.0 — 2019-06-18
- 1.0.0 — 2019-06-18

## README

# @codeekage/nab

[![npm (scoped)](https://img.shields.io/badge/nab-v1.2.5-green.svg)](https://github.com/codeekage/nab)


## NAB (Node-web-API-Builder)

NAB is an open source opinionated architectural design for building Node.js Web APIs with an OOP (Object-Oriented Programming) paradigm, and typescript as it’s language. NAB focuses on improving the DX (Developer Experience) when building Node.js Web APIs with Typescript using it’s CLI tool for easy setups. 

### Setting up `nab`

```shelll 
$ npm install -g @codeekage/nab typescript nodemon
```
>  typescript && nodemon can be omitted if already have them installed

```shell // create a new nab-typescript-project

$ nab create --typescript <project-name>
```

This unpacks a basic structured design you need when building a Node.js Web API with typescript. 

NAB takes after the MVC approach for building web applications but excluding the “V” (view). 

NAB is mainly for building Web APIs, and it achieves this by using an “MC”  (Model-Controllers) approach from the MVC architecture. In future, NAB hopes to support a more dynamic structure that’ll also include popular view frameworks. 

Currently, NAB accomplishes its Model-Controllers approach by leveraging technologies like Express, and MongoDB. Where Express acts as it’s controller and MongoDB for its model. 

NAB is not a framework for building Node.js applications, but a structure, a design, or a concept to ease building node.js web APIs with typescript lang.

There’s no magic, or behind the scene events, or APIs, everything that makes up the design, and the concept is available right in the code, making it easy to what you don’t need, and what you really do need. 

NAB further it’s DX (Developer Experience) by providing commands to scaffold models, and controllers when building nodejs web APIs. 

```shell
// create new model
$ nab add model --typescript <model-name>
```

```shell
// create new controller
$ nab add controller --typescript <controller-name>
```

**Start Dev Mode**

```shell
$ nab start --typescript dev
```

**More Options**

```
$ nab --help
```

---
_Source: https://npm.io/package/@codeekage/nab · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._