neg3ntropy / ninjagoat

The not so baaaaaaad MVVM framework.

#Ninjagoat

The not so baaaaaaad MVVM framework.

Introduction

Ninjagoat is an attempt at writing a simple, lightweight, modular, reactive, convention-based, eventsource ready MVVM framework. Oh, and we are writing it in Typescript, so we expect that you will use that, too! If this is not the case don't worry, you can use Ninjagoat anyway, but you will lose part of the fun.

Ninjagoat is currently being developed internally for being used in our single page frontend applications, which require live updates of data coming from a server, and are composed of multiple modules. Besides being developed with Event Sourcing in mind, it can be used also in conventional scenarios.

This is a work in progress, so if you will expect lots of changes you won't get disappointed.

Installation

You can find Ninjagoat on npm:

npm install ninjagoat --save

If you are using Typescript you will have to add support for decorators in the tsconfig.json file, as we are using InversifyJS as our IoC container.

{
  "compilerOptions": {
    "experimentalDecorators": true,
    "emitDecoratorMetadata": true
  }
}

As Ninjagoat is written in Typescript, you can find the type definitions here:

/// <reference path="node_modules/ninjagoat/dts/ninjagoat.d.ts" />

Ok, I got it. What now?

If you've made it so far, you might be interested in one of these excellent topics:

• Getting started - will show you how to get up and running with Ninjagoat, with the classic hello world example.
• Architecture - will tell you a bit more about how Ninjagoat does things internally. This might be boring stuff for you, if what you need is just use the library, so feel free to skip it.
• Roadmap - here you will find a few insights about where we want to go and what is planned for future versions
• Contribute! - welcome to Duloc such a perfect town, here we have some rules, let us lay them down...

License

Copyright 2016 Tierra SpA

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.