Git Product home page Git Product logo

project-analytics's Introduction

Clubhouse Project Analytics

Example Project Screenshot

A historical library that fetches data from your Clubhouse organization and displays various metrics using Google Charts. Demonstrates how to combine the Clubhouse API and Google Charts to create an analytics dashboard that measures any arbitrary aspect of your Clubhouse data.

โš ๏ธ Note that this repo is unmaintained, unsupported, and for historical reference only.

Installation

Install Node.js on your machine if you don't already have it installed.

# Clone the repo.
git clone [email protected]:clubhouse/project-analytics.git
cd project-analytics

# Install node dependencies. You only need to do this once.
npm install

# Add your Clubhouse API token as an environment variable.
# (Go to Clubhouse > Settings > Your Account > API Tokens to create one.)
CLUBHOUSE_API_TOKEN="MY TOKEN"

Usage

# Fetch and compile your data by project. You can use a partial project name,
# e.g. "AP" will match projects starting with both "API" and "App". Leaving off
# the project-name will list the projects you have access to.
node fetch.js <project-name>

# Or, just fetch and compile data for all active (non-archived) projects:
node fetch.js all

# Finally, open the HTML file in your browser and select a project:
open index.html

project-analytics's People

Contributors

andrewchilds avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar

project-analytics's Issues

Add visualization of story dependencies

We use story relationships (blocks and is blocked by) to express dependencies. It would be tremendously useful to visualize these relationships in a DAG, as this would show the critical path. Knowing which story is a head-of-line blocker helps understanding where to channel efforts for maximum productivity.

A visualization in the form of a DAG makes this obvious: the node with the highest in-degree represents the story with the most bang for the buck.

Have you considered such an enhancement?

Missing `data` Directory on Fresh Clone.

This is a super minor issue, but for the less technically inclined, it can introduce unnecessary barriers.

On a fresh clone, the data directory does not exist.

Executing node fetch.js all results in the following top-level exception:

Fetching projects...
  return binding.open(pathModule._makeLong(path), stringToFlags(flags), mode);
                 ^

Error: ENOENT: no such file or directory, open 'data/projects.js'
    at Object.fs.openSync (fs.js:582:18)
    at Object.fs.writeFileSync (fs.js:1301:33)
    at saveProjectsToFile (/.../project-analytics/fetch.js:210:6)
    at Request._callback (/.../project-analytics/fetch.js:254:5)
    at Request.self.callback (/.../project-analytics/node_modules/request/request.js:188:22)
    at emitTwo (events.js:106:13)
    at Request.emit (events.js:192:7)
    at Request.<anonymous> (/.../project-analytics/node_modules/request/request.js:1171:10)
    at emitOne (events.js:96:13)
    at Request.emit (events.js:189:7)

The README.md should be updated to include the step to create the directory. Or better yet, the repository should include the empty directory, with a .gitignore.

Documentation for adding clubhouse api token is incorrect

When I followed the instructions on your page I saw that you ask users to:

Add your Clubhouse API token as an environment variable.
(Go to Clubhouse > Settings > Your Account > API Tokens to create one.)
run CLUBHOUSE_API_TOKEN="MY TOKEN"`

when it should be export CLUBHOUSE_API_TOKEN="YOUR API TOKEN HERE"

Clubhouse API V2

Hi Andrew,

I just wanted to let you know that we've released Clubhouse API V2. While V1 will continue to be supported, V2 exposes endpoints for several new features such as Teams, Milestones, and Categories.

Thanks,
Camille

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.