Dashboard with lean metrics for agile companies which are using Atlassian Jira.
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
app
bin
src
vendor
web
.gitignore
LICENSE
README.md
composer.json
index.php

README.md

Agile Dashboard - Community Edition

Dashboard with agile metrics connected to Atlassian Jira.

Sample Dashboard

Requirements

  • PHP >= 5.5.9 (with php5-curl, php5-mcrypt)
  • Composer
  • Mysql

How to install

  1. Download and install Composer.

  2. Clone or download the repository:

     $ git clone https://github.com/rgies/agile-dashboard.git
     $ cd agile-dashboard
    

How to configure

  1. Start setup and follow the instuctions:

     $ composer install
    
  2. Create database table

     $ app/console doctrine:database:create
    
  3. Update database schema

     $ app/console doctrine:schema:update --force
    
  4. Load initial data

     $ app/console doctrine:fixture:load
    

    Note: Default login credentials (admin/admin). Please login an change password.

Usage

Table of Contents

Setup

Development

Setup service provider

  1. Login as Administrator (Default: admin/admin)

  2. Go to the "Service Provider" section

  3. Click on Jira and put in the login credentials

Develop own widgets

  1. Create widget code skeleton

     $ app/console dashboard:generate:widget
    
  2. Add generated widget name to config

    app/config/widget.yml

     # Widget plugins
     widget_plugins:
         'MyWidgetBundle': 'My widget name'
    
  3. Insert view and controller code

    Resources/views/Default/widget.html.twig

     {% block widget_body %}
         <!-- ADD HERE YOUR WIDGET CONTENT -->
         ...
     {% endblock %}
    

    Controller/DefaultController.php

     // ======================================================
     // INSERT HERE YOUR CODE TO COLLECT THE NEEDED DATA
     // ======================================================
     $response = array(
         'value' => $insert_here_your_data
     );
     // ======================================================
    
  4. Optional change data model

    1. Adapt entity file Entity/WidgetConfig.php

    2. Adapt form file Form/WidgetConfigType.php

  5. Update database schema

     $ app/console doctrine:schema:update --force