Code Monkey home page Code Monkey logo

restmine-scrum-board's Introduction

RESTmine SCRUM Board

A Scrum Board based on the REST API of Redmine.

  • built upon the REST-API of Redmine 3.3
  • requires set-up of two custom issue fields
    • Sprint Number
    • Story Points
  • client and server part
    • hide the API-key server-side & do some pre-calculations (velocity)
    • server is written on NodeJS, client is a VueJS application

Usage

  1. Copy ./config/config.dist.json to ./config/config.json
  2. Enable Redmine REST API
    1. click Administration link on top left
    2. go to tab API
    3. enable REST web service
  3. Gather Redmine API key
    1. click My account link on top right
    2. click Show within the sidebar section API access key
    3. copy the API key to ./config/config.json
  4. Setup custom Sprint Number field
    1. click Administration link on top left
    2. click Custom fields
    3. create new custom field on type Issues (see screenshot)
      • create as format Integer
      • call it e.g. Sprint number
      • choose all trackers
    4. after pressing Save, copy the numeric ID from the URL to customSprintNumberFieldId of ./config/config.json
  5. Setup custom Story Points field
    1. click Administration link on top left
    2. click Custom fields
    3. create new custom field on type Issues (see screenshot)
      • create as format Integer or use format Key/value list (this would enable you to enforce certain Fibonacci numbers: 1, 2, 3, 5, 8, 13)
      • call it e.g. Story points
      • choose all trackers, except Bug (only features receive an estimation)
    4. after pressing Save, copy the numeric ID from the URL to customStoryPointsFieldId of ./config/config.json
  6. Configure Issue statuses as required; possible changes might include:
    • a new status To Test, To Review and/or To Deploy
  7. Run
    • docker-compose build && docker-compose up
  8. Open: http://localhost:8083

Screenshots

Issues Default View

Within ./config/config.json you can define the mapping from Redmine issue statuses to SCRUM Board statuses:

   ...
   "columns": {
     "new": {
       "abbr": "new",
       "name": "New",
       "statuses": [
         "New",
         "Accepted",
         "Reopened",
         "Feedback Provided"
       ]
     },
     ...

Screenshot

Issues Project View

Alternative view where each Redmine project is represented as horizontal swimlane.

Screenshot

Distribution

Gives you various statistics about workload distribution.

Screenshot

Velocity

History of development speed.

Screenshot

Settings

Change the Sprint number.

Screenshot

HTTPS

If run behind a HTTPS terminator, you have to offload the secure WebSocket (ws://) connection as well. On Nginx you can this via:

location /ws/ {
    // this proxies the wss:// connection to ws://
    proxy_pass http://127.0.0.1:8083;
    proxy_http_version 1.1;
    proxy_set_header Upgrade $http_upgrade;
    proxy_set_header Connection "upgrade";
}

Development

ToDo

  • Issues tab
    • drag & drop issues across status
    • drag & drop users onto issues
  • Distribution tab
    • show doneRatio - this is complicated as the spent_hours field is only available in issues-detail view, but not within issues-list view

restmine-scrum-board's People

Contributors

shaula avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.