npm package: @neoskop/nem
Description: Strucktured modules to build express apps
Author: Mark Wecke
Latest version: 0.6.0-rc.5

# @neoskop/nem

> Strucktured modules to build express apps

Master
[![Travis master][travis-master-image]][travis-master-url]
[![Test coverage master][coveralls-master-image]][coveralls-master-url]
[![Known Vulnerabilities master][snyk-master-image]][snyk-master-url]

Develop
[![Travis develop][travis-develop-image]][travis-develop-url]
[![Test coverage develop][coveralls-develop-image]][coveralls-develop-url]
[![Known Vulnerabilities develop][snyk-develop-image]][snyk-develop-url]

## Installation

```sh
$ yarn add @neoskop/nem             # via yarn

$ npm install --save @neoskop/nem   # via npm
```

## Usage

```typescript
import { nem, NemModule, Controller, Get, View } from '@neoskop/nem';

@Controller()
export class ExampleController {
    @Get('/')
    @View('index')
    index() {
        return {
            title: 'Example'
        }
    }
}


@NemModule({
    controller: [
        [ '/', ExampleController ]
    ]
})
export class ExampleModule {

}

nem().bootstrap(ExampleModule).listen(8000);
```

See [samples](./samples) for for more examples.

### Dependency Injection

```
                                                                        +-----------------------+
                                                                        |     rootProviders     |
                                                                        v                       |
+------------------------------+     +--------------------+     +---------------+     +-----------------+     +---------------------+
| Provided Injector (Optional) | --> | Bootstrap Injector | --> | Root Injector | --> | Module Injector | --> | Controller Injector | 
+------------------------------+     +--------------------+     +---------------+  ^  +-----------------+  |  +---------------------+
                                                                                   |                       |
                                                                                   |     Nested Modules    |
                                                                                   +-----------------------+
```

The bootstrap injector contains the required dependencies to bootstrap the app, 
the root injector inherits from the bootstrap injector and contains all global depenendencies.  
The module injectors inherits from the parent module injector or the root injector for the root module.

## Testing

```sh
yarn test
```

## Building

```sh
yarn run build
```

## License

MIT License

Copyright (c) 2018 Neoskop GmbH

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.


## Sponsor

[![Neoskop GmbH][neoskop-image]][neoskop-url]

[travis-master-image]: https://img.shields.io/travis/neoskop/nem/master.svg
[travis-master-url]: https://travis-ci.org/neoskop/nem
[travis-develop-image]: https://img.shields.io/travis/neoskop/nem/develop.svg
[travis-develop-url]: https://travis-ci.org/neoskop/nem
[snyk-master-image]: https://snyk.io/test/github/neoskop/nem/master/badge.svg
[snyk-master-url]: https://snyk.io/test/github/neoskop/nem/master

[coveralls-master-image]: https://coveralls.io/repos/github/neoskop/nem/badge.svg?branch=master
[coveralls-master-url]: https://coveralls.io/github/neoskop/nem?branch=master
[coveralls-develop-image]: https://coveralls.io/repos/github/neoskop/nem/badge.svg?branch=develop
[coveralls-develop-url]: https://coveralls.io/github/neoskop/nem?branch=develop
[snyk-develop-image]: https://snyk.io/test/github/neoskop/nem/develop/badge.svg
[snyk-develop-url]: https://snyk.io/test/github/neoskop/nem/develop

[neoskop-image]: ./neoskop.png
[neoskop-url]: https://www.neoskop.de/