ng.cork.model

AngularJS services and classes for complex model layers.

Getting Started

Add ng.cork.model to you project.

Via bower:

$ bower install --save ng.cork.model

Via npm:

$ npm install --save ng.cork.model

Include the following JS files in your build:

dist/ng.cork.model.js OR dist/ng.cork.model.min.js

The following bower dependencies must also be included:

vendor/ng.cork.util/dist/ng.cork.util.js
vendor/ng.cork.deep/dist/ng.cork.deep.js

Alternatively, include only the files you are going to use:

dist/lib/ng.cork.model.space.js
dist/lib/ng.cork.model.model.js
dist/lib/ng.cork.model.factory.js
... but don't forget to load modules required by these ...

Documentation

Make sure to check the official documentation where you can find a guide, a few demos and the complete API reference.

Contributing

We'd love for you to contribute to our source code and to make it even better than it is today!

Make sure you read the Contributing Guide first.

Developing

Clone this repository, install the dependencies and simply run grunt develop.

$ npm install -g grunt-cli bower
$ npm install
$ bower install
$ ./bootstrap.sh
$ grunt develop

At this point, the source was validated, tested and built into the build/ directory. A simple webserver is launched so that you can browse the generated code, documentation and the code coverage. If you now edit and save any project file, the necessary grunt tasks will be triggered to update the build and docs.

...
Running "serve:build" (serve) task
Started connect web server on http://0.0.0.0:8000

Running "watch" task
Waiting...

More info on the (Grunt based) tools can be found in the boilerplate documentation.

MIT License

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.