dashing-js
Version:
Port of Dashing to node.js
57 lines (37 loc) • 1.95 kB
Markdown
# dashing-js
Port of [Dashing](http://shopify.github.io/dashing/) to node.js
[](http://badge.fury.io/js/dashing-js)
[](https://david-dm.org/fabiocaseri/dashing-js)
[](https://bitdeli.com/free "Bitdeli Badge")
## Getting Started
1. Install from npm
```shell
$ npm install -g dashing-js
```
2. Generate a new project
```shell
$ dashing-js new sweet_dashboard_project
```
3. Change your directory to sweet_dashboard_project and install required modules
```shell
$ cd sweet_dashboard_project && npm install
```
4. Start the server!
```shell
$ dashing-js start
```
5. 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 <del>[Sprockets](https://github.com/sstephenson/sprockets)</del> [Mincer](http://nodeca.github.io/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 html/css/coffee for individual widgets.
Run `dashing-js` from command line to find out what command line tools are available to you.
## Deployment
dashing-js is setup to be easily deployed on a Joyent Node SmartMachine. This means that:
1. The version of Node is defined in package.json
2. The main script to run is server.js
3. The web server port is pulled from process.env.PORT