starefossen / build-your-own-radar Goto Github PK

A library that generates an interactive radar, inspired by thoughtworks.com/radar.

You can see this in action at https://radar.thoughtworks.com. If you plug in this data you'll see this visualization.

The easiest way to use the app out of the box is to provide a public Google Sheet ID from which all the data will be fetched. You can enter that ID into the input field on the first page of the application, and your radar will be generated. The data must conform to the format below for the radar to be generated correctly.

You need to make your data public in a form we can digest.

Create a Google Sheet. Give it at least the below column headers, and put in the content that you want:

• In Google sheets, go to 'File', choose 'Publish to the web...' and then click 'Publish'.
• Close the 'Publish to the web' dialog.
• Copy the URL of your editable sheet from the browser (Don't worry, this does not share the editable version).

The URL will be similar to https://docs.google.com/spreadsheets/d/1waDG0_W3-yNiAaUfxcZhTKvl7AUCgXwQw8mdPjCz86U/edit. In theory we are only interested in the part between '/d/' and '/edit' but you can use the whole URL if you want.

Paste the URL in the input field on the home page.

That's it!

Note: the quadrants of the radar, and the order of the rings inside the radar will be drawn in the order they appear in your Google Sheet.

To create the data representation, you can use the Google Sheet factory, or you can also insert all your data straight into the code.

The app uses Tabletop.js to fetch the data from a Google Sheet, so refer to their documentation for more advanced interaction. The input from the Google Sheet is sanitized by whitelisting HTML tags with sanitize-html.

The application uses webpack to package dependencies and minify all .js and .scss files.

All tasks are defined in package.json.

Pull requests are welcome; please write tests whenever possible.

• git clone [email protected]:thoughtworks/build-your-own-radar.git
• npm install
• npm test - to run your tests
• npm run dev - to run application in localhost:8080. This will watch the .js and .css files and rebuild on file changes