Skip to content

srinidhis05/dashku

 
 

Repository files navigation

Build Status Coverage Status Dependency Status Dev Dependency Status Code Climate Gitter chat Issue Stats Issue Stats

Dashku (classic edition)

Dashku Screenshot

Introduction

Dashku is a web application for creating dashboards and widgets in HTML, CSS, and JavaScript. It is open source, and available to download from Github. There is also a hosted edition at Dashku.com.

Dependencies

  • Node.js (0.10)
  • MongoDB
  • Redis

Install on Heroku

You can also deploy your own copy with Heroku's click-to-deploy button below:

Deploy

Note: If you deploy to Heroku, you will want to enable these features in Heroku Labs for your app:

heroku labs:enable http-session-affinity
heroku labs:enable http-end-to-end-continue

This will ensure that the app's use of WebSockets will work smoothly.

Installation (with Docker)

The best way to install Dashku with Docker is by using Docker Compose:

docker pull anephenix/dashku
docker-compose up

We will be working on getting linked containers to work with Dashku's docker container, as well as updating the container with the latest version of Dashku.

Manual installation (with Git)

git clone git://github.com/Anephenix/dashku.git
cd dashku
npm install

Booting the application

mongod &
redis-server &
npm start

Seeding the database with widget templates

You can seed Dashku's database with widget templates by running this command:

npm run populateWidgetTemplates

If using docker-compose then run the following:

docker-compose run web npm run populateWidgetTemplates

Using Dashku to create dashboards and widgets

Documentation will be coming soon.

Development and Testing

If you wish to extend Dashku, and want to know run unit/functional tests, do this:

npm test

To run the integration tests:

npm run cuke

Code coverage is currently in the region of 74%. This will be increasing in the near future.

License & Credits

© 2015 Anephenix Ltd. The Nike swoosh is a registered trademark of Nike Inc. Dashku is a trademark of Anephenix Ltd, and dashku is licenced under the LGPLv3 license. See LICENSE for details.

Packages

No packages published

Languages

  • JavaScript 84.1%
  • CSS 5.6%
  • Gherkin 4.3%
  • HTML 3.7%
  • CoffeeScript 1.9%
  • PHP 0.2%
  • Other 0.2%