Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/just-dandi/dandi

🌻A modular DI, MVC, and Model binding/validation framework for NodeJS and TypeScript or ES6
https://github.com/just-dandi/dandi

aws aws-lambda dependency-injection di express expressjs firebase javascript model-validation mvc mvc-framework node nodejs postgres server-framework typescript validation

Last synced: 3 days ago
JSON representation

🌻A modular DI, MVC, and Model binding/validation framework for NodeJS and TypeScript or ES6

Awesome Lists containing this project

README 

        
# @dandi



![](https://img.shields.io/github/release-pre/just-dandi/dandi.svg)

[![Build Status](https://travis-ci.org/just-dandi/dandi.svg?branch=master)](https://travis-ci.org/just-dandi/dandi)

[![Coverage Status](https://coveralls.io/repos/github/just-dandi/dandi/badge.svg)](https://coveralls.io/github/just-dandi/dandi)

[![License: MIT](https://img.shields.io/badge/license-MIT-green.svg)](https://opensource.org/licenses/MIT)

![](https://img.shields.io/snyk/vulnerabilities/github/just-dandi/dandi.svg)



Dandi is a modular DI and MVC application framework designed to make it easier to write RESTful APIs, console

applications, and other services for NodeJS with TypeScript. It is split into modules to allow developers to use only

the features they require.



[Get Started](./packages/dandi/core)



## Use Cases



- MVC-style Application Servers

- CLI Applications

- AWS Lambda functions



## Features



### Dependency Injection



- Modeled after [Angular](https://angular.io)'s dependency injection system

- Inject dependencies into class constructors or methods

- 3rd party dependencies can be configured to be injected with Providers



### HTTP Pipeline



- Standalone pipeline for handling and responding to HTTP requests

- Automatic input content negotiation based on request `content-type` header

- Automatic output content negotiation based on request `accept` header

- Create and configure interdependent middleware handlers (`HttpPipelinePreparer`) and they will automatically be

  invoked in the correct order

- Add global transformers to control response data structure



### MVC



- Modeled after [ASP.NET Core MVC](https://docs.microsoft.com/en-us/aspnet/core/mvc/overview)

- Builds on functionality of `@dandi/http-pipeline` to add routing and other MVC features

- Web framework agnostic - Built for [Express 4](https://expressjs.com/), but can be used with other frameworks if desired

- Decorator-based route configuration

- Automatic path parameter, query parameter, and body model mapping and validation

- Support for automatically generating [HA JSON](http://stateless.co/hal_specification.html) output



### Model Building and Validation



- Robust set of decorators for defining models and validation metadata

- Automatically construct model class instances from JSON objects or POJOs

- Convert from objects using a different property key casing

  (e.g. `snake_case` to `camelCase`)



### AWS Lambda



- Wraps `@dandi/http-pipeline` for use with handline AWS Lambda requests

- Use the same framework, models, and add-ons (`HttpPipelinePreparer`, `HttpPipelineResultTransformer`) between your

  Lambda functions and MVC API



### Misc



- `Disposable` interface and utilities for managing disposable resources

- Uses [Luxon](https://moment.github.io/luxon/) as a replacement for Date objects

- Models can be reused between backend NodeJS and frontend TypeScript/JavaScript applications

- `Uuid` class based on the [uuid](https://github.com/kelektiv/node-uuid) library for working with and comparing UUIDs.



## Core Modules



- **[@dandi/cache](./packges/dandi/cache)** - Caching functionality

- **[@dandi/common](./packages/dandi/common)** 🕸 - Common types and utilities

- **[@dandi/config](./packages/dandi/config)** 🕸 - Configuration services

- **[@dandi/core](./packages/dandi/core)** 🕸 - Dependency Injection

- **[@dandi/core/logging](./packages/dandi/core/logging)** 🕸 - Core logging and configuration

- **[@dandi/core-node](./packages/dandi/core-node)** - Additional DI utilities specific to NodeJS

- **[@dandi/data](./packages/dandi/data)** 🕸 - Base types and utilities for working with data services

- **[@dandi/hal](./packages/dandi/hal)** - 🕸 - Model decorators, basic types and utilities for supporting HAL

- **[@dandi/hal-model-builder](./packages/hal-model-builder)** - 🕸 - Model building utilities supporting HAL embedded resources

- **[@dandi/http](./packages/http)** - Types, utilities and DI tokens for basic HTTP concepts (headers, mime types, etc)

- **[@dandi/http-model](./packages/http-model)** - Types, decorators, and utilities for using model building and validation in an HTTP context

- **[@dandi/http-pipeline](./packages/http-pipeline)** - A pipeline for handling and responding to HTTP requests

- **[@dandi/logging](./packages/dandi/logging)** - 🕸 - Additional utilities for logging and logging configuration

- **[@dandi/model](./packages/dandi/model)** 🕸 - Decorators for describing models, for use with `@dandi/model-builder`

- **[@dandi/model-builder](./packages/dandi/model-builder)** 🕸 - Utilities for dynamically constructing and validating models

- **[@dandi/mvc](./packages/dandi/mvc)** - MVC decorators and base utilities (not specific to Express)

- **[@dandi/mvc-hal](./packages/dandi/mvc-hal)** - Supports rendering HAL JSON from existing `@dandi/mvc` controllers

- **[@dandi/mvc-view](./packages/dandi/mvc-view)** - Use `@dandi/mvc` with your favorite templating engine



## 3rd Party Integration Modules



- **[@dandi-contrib/aws-lambda](./packages/dandi-contrib/aws-lambda)** Helpers for using `@dandi/core` and `@dandi/http-pipeline` with AWS Lambda

- **[@dandi-contrib/config-aws-ssm](./packages/dandi-contrib/config-aws-ssm)** - `@dandi/config` client for AWS SSM Parameter Store

- **[@dandi-contrib/data-pg](./packages/dandi-contrib/data-pg)** - `@dandi/data` client implementations for Postgres

- **[@dandi-contrib/mvc-auth-firebase](./packages/dandi-contrib/mvc-auth-firebase)** - Google Firebase Authorization service implementation for `@dandi/mvc`

- **[@dandi-contrib/mvc-express](./packages/dandi-contrib/mvc-express)** - Express-specific `@dandi/mvc` service implementations

- **[@dandi-contrib/mvc-view-ejs](./packages/dandi-contrib/mvc-view-ejs)** - [EJS](https://ejs.co) implementation for `@dandi/mvc-view`

- **[@dandi-contrib/mvc-view-pug](./packages/dandi-contrib/mvc-view-pug)** - [Pug](https://pugjs.org) implementation for `@dandi/mvc-view`



🕸 - web browser compatible/no NodeJS-specific dependencies



## Examples



[Simple Express REST API](./_examples/simple-express-rest-api) - An

implementation of a very simple REST API using `@dandi`



## Dev Setup



To set up this project as a local repository:



- [Install Yarn Classic](https://classic.yarnpkg.com/en/docs/install) if you don't have it installed

- After cloning the repostory, run `yarn setup` - this will install the dependencies for all the individual packages,

  as well as the Dandi builder

- You can now run `yarn build` to build all packages, or `yarn test` to run all tests