Skip to content
This repository has been archived by the owner on Jul 8, 2024. It is now read-only.

Visualize Shortcut Project data using Google Charts.

License

Notifications You must be signed in to change notification settings

useshortcut/project-analytics

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

5 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

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