https://github.com/jusx/bagels

https://github.com/jusx/bagels

Last synced: about 2 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/jusx/bagels
• Owner: jusx
• License: mit
• Created: 2017-11-04T02:29:38.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2017-11-15T21:33:34.000Z (about 7 years ago)
• Last Synced: 2024-10-11T19:51:19.442Z (3 months ago)
• Language: JavaScript
• Size: 57.6 KB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Bagel

A bagel is a donut chart used to display single key value with a color coded performance level indicator. It is theme-able, extensible and visually pleasing and is typically found in infographics and dashboards.

It is great for showing progress or performance (KPI) that can be quickly understood at a glance.

# Goals

The primary goals for this project is:

1. It can be easily wrapped within framework components like ReactJS, Angular and VueJS.

2. It can be easily themed with CSS but comes with default rendered themes out of the box.

3. It can be easily extended using inheritance and/or other OO design patterns.

# Note

This is an experimental project. The direction of it may change at any time.

# Tests

There will be no unit tests while the project is still in POC status. Instead a visual test is created by visually inspecting output through `demos/bagel.html`

# Contributions

Any suggestions or ideas through Pull Requests or issues are welcome.

# Distribution

Not ready for distribution while still under development and in POC status.