LeanSheets

A tool that creates Cumulative Flow, Histogram, and Control charts for Kanban systems based off of a Google Spread Sheet.

Life Cycle

1. Loads /config.json
2. Loads the Configuration from your Google Spread Sheet that you have defined
3. Fires a $broadcast event to other chart's controllers for them to draw their chart

Installing & Running

You have three options to run LeanSheets:

1. Use the docker image.
   

    docker run -v /path/to/local/config.json:/usr/src/app/src/config.json -p 8081:8081 satvidh/leansheets
   

   • The above command-line refers to /path/to/local/config.json. This relies on a config.json file. The format of this file should match

       {
           "sheets": {
               "Sheet: Demo Team": {
                   "configUrl": "https://docs.google.com/spreadsheets/d/12cvMUMnWEKynGTsyXQywvJ9drpjYAyyo0-2cnTUJSFw/edit?gid=44020743",
                   "dataUrl": "https://docs.google.com/spreadsheets/d/12cvMUMnWEKynGTsyXQywvJ9drpjYAyyo0-2cnTUJSFw/edit?gid=497466409"
               }
           },
           "debugEnabled": true,
           "showAllWork": true,
           "cacheTtl": 300,
           "datePickerFormat": "mm/dd/yyyy",
           "datePickerMomentFormat": "MM/DD/YYYY",
           "queryDateMomentFormat": "YYYY-MM-DD",
           "defaultHistoricalNumberOfDays": 60
       }
     

   • On Mac or Windows, use the Docker Toolbox for docker support.

   • The above command-line also has the -p 8081:8081 option, which exposes port 8081 from the container.

     • If you are on Mac or Windows and use docker-machine to host the docker daemon, then use the following command to expose port 8081 with the virtualbox driver and a docker-machine named default.

         vboxmanage controlvm default natpf1 "tcp-port8081,tcp,127.0.0.1,8081,,8081"
       

   • NOTE If you choose this option, you can skip the need to download source code altogether.

2. Download either the .zip or the tar.gz

   • If you choose this option you can skip the steps of installing Git and running "git clone" in the below instructions.

3. Clone the Git repo.

   • If you choose this step follow all the below instructions.

Installation instructions:

See the video here:

http://www.screencast.com/t/q0aWDzuQGn

Download and Install the following

Nodejs - http://www.nodejs.org

Click the “Install” button on the page

Git - https://git-scm.com/downloads

Click on the OS you use

Once these two programs are installed do the following steps:

If you are running Windows make sure to run the "GIT Bash" program from your Start menu. This will get you the command prompt you will need to run the below commands.

If you are running Mac you will want to run the following commands from your "Terminal."

cmd> git clone https://github.com/paulsjv/leansheets.git
cmd> cd leansheets
cmd> npm install -g bower <may have to run as root>
cmd> npm install -g grunt-cli <may have to run as root>
cmd> npm install grunt
cmd> bower install
cmd> npm install
cmd> grunt run

Open the link in your browser:

http://localhost:8081

Choose a date between 11/1/2014 and 4/31/2015. See the Google Sheet here for the data your local instance is currently running.

https://docs.google.com/spreadsheets/d/12cvMUMnWEKynGTsyXQywvJ9drpjYAyyo0-2cnTUJSFw/edit?gid=44020743#gid=497466409

Update to use your own Google Sheet

Update the ./src/config.json file to be like below (Google Sheet is the demo when you first run and lauch LeanSheets in your browser). Make sure you change the key and the gid in the URL. Also, depending on what version of Google Sheets you are running the URL might be slightly different. If you can not figure it out please open an issue on the github page.

https://docs.google.com/spreadsheets/d/[key]/edit?gid=[gid]

{
  "sheets": {
      "Sheet: Demo Team": {
          "configUrl": "https://docs.google.com/spreadsheets/d/12cvMUMnWEKynGTsyXQywvJ9drpjYAyyo0-2cnTUJSFw/edit?gid=44020743",
          "dataUrl": "https://docs.google.com/spreadsheets/d/12cvMUMnWEKynGTsyXQywvJ9drpjYAyyo0-2cnTUJSFw/edit?gid=497466409"
      }
  },
 "debugEnabled": true,
  "showAllWork": true,
  "cacheTtl": 300,
  "datePickerFormat": "mm/dd/yyyy",
  "datePickerMomentFormat": "MM/DD/YYYY",
  "queryDateMomentFormat": "YYYY-MM-DD",
  "defaultHistoricalNumberOfDays": 60
}

Running Tests

Coming Soon