Skip to content

Latest commit

 

History

History
90 lines (60 loc) · 3.93 KB

README.md

File metadata and controls

90 lines (60 loc) · 3.93 KB
Raw

angular-dashboard-framework

Packagist Build Status Coverage Status Dependency Status Join the chat at https://gitter.im/sdorra/angular-dashboard-framework

Dashboard framework with Angular.js and Twitter Bootstrap.

The api of angular-dashboard-framework (adf) is documented here. A getting started guide can be found here. Follow me (@ssdorra) on twitter for latest updates and news about adf.

Demo

A live demo of the adf can be viewed here. The demo uses html5 localStorage to store the state of the dashboard. The source of the demo can be found here.

A more dynamic example can be found here.

Build from source

Install bower and gulp:

npm install -g bower
npm install -g gulp

Clone the repository:

git clone https://github.com/angular-dashboard-framework/angular-dashboard-framework
cd angular-dashboard-framework

Install dependencies:

npm install
bower install

Checkout git submodule widgets:

git submodule init
git submodule update

You can start the sample dashboard, by using the serve gulp task:

gulp serve

Now you open the sample in your browser at http://localhost:9001/sample

Or you can create a release build of angular-dashboard-framework and the samples:

gulp all

The sample and the final build of angular-dashboard-framework are now in the dist directory.

Contributing

Please do not commit changes to the dist folder. The dist folder is only generated for releases.

License

The MIT License

Copyright (c) 2015, Sebastian Sdorra

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.