node package manager
Orgs are free. Discover, share, and reuse code in your team. Create a free org »

vue-dashing-js

vue-dashing-js

This is a fork of nuvo-dashing-js replacing Batman.js with Vue.js

Getting Started

  1. Install from npm
$ npm install -g vue-dashing-js
  1. Generate a new project
$ dashing-js new sweet_dashboard_project
  1. Change your directory to sweet_dashboard_project and install required modules
$ sudo npm install -g browserify watchify
cd sweet_dashboard_project && npm install
  1. Start the automatic asset compilation task:
$ npm run watch
  1. Start the server!
$ dashing-js start
  1. Point your browser at http://localhost:3030/ and have fun!

Every new Dashing project comes with sample widgets & sample dashboards for you to explore. The directory is setup as follows:

  • Assets — All your images, fonts, and js/coffeescript libraries. Uses Sprockets Mincer.
  • Dashboards — One .jade file for each dashboard that contains the layout for the widgets.
  • Jobs — Your js/coffee jobs for fetching data (e.g for calling third party APIs like twitter). Name them *.job.js/*.job.coffee
  • Lib — Optional js/coffee files to help out your jobs.
  • Public — Static files that you want to serve. A good place for a favicon or a custom 404 page.
  • Widgets — All the vue templates for individual widgets.

Run dashing-js from command line to find out what command line tools are available to you.

TODO

  • Implement all the basic widgets
  • Add a websocket option
  • Refactoring