himedlooff / dox-ray-angular-demo

An Angular playground to test out Dox-ray.

Dox-ray Angular demo

An Angular playground to test out Dox-ray.

Getting started

Installing dependencies (one time)

Install node.js however you'd like.

Then Install Grunt and Bower:

$ npm install -g grunt-cli bower

Developing

# Install/update npm and bower dependencies:
$ npm install
$ grunt vendor
# Build the JSON file using Dox-ray, this will be the model used in Angular:
$ grunt make-docs
# Compile the CSS and JS:
$ grunt
# You can manually compile the CSS or JS with the following tasks:
$ grunt cssdev
$ grunt jsdev
# You can also automatically compile CSS and JS by running the watch task:
$ grunt watch

Getting involved

Feedback and contributions are welcome. Please read CONTRIBUTING.

To file a bug please us this handy template.

---

Open source licensing info

This projected is licensed under the terms of the MIT license.