Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md with Description & How-to-Use #123

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
48 changes: 46 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,51 @@
<h1><a href='https://awesome.cube.dev'>awesome.cube.dev</a> — charts, data grids, maps, etc.</h1>

Choose the best tool for your needs by type, framework, language, or license. Get started in an instant.
<p>Choose the best tool for you needs by type, framwork, language, or license. Get started in an instant!</p>

<p align="center"><img src='.github/screenshot.png'/></p>

Visit [awesome.cube.dev](https://awesome.cube.dev) or suggest an [improvement](https://github.com/cube-js/awesome-tools/issues).
<h2>Description</h2>
<p>This web-application is a collection of 61+ front-end data analysis tools for application developers. Limit your search by the type of tool, framework, license, rendering, or a combination of any of categories!</p>
<p>This project was primarily developed by Javascript to allow maximized interaction between the user and the application. SCSS and CSS were both used to style the engaging UI.</p>

<h2>How to Use</h2>
<p>Simply click on the filter(s) you want to apply and scroll down to find a list of applicable tools. Unclick to de-select. After finding a tool best-sutied for your interests, click on it and you will be taken to a page containing its Github repository, website, statisitcs (ie. stars, open issues, contributors, and last release date). There will also be a gallery picturing data visualizations the tool created!</p>

<h3>Tools:</h3>
<ol>
<li>Charting libraries: create various charts (ie. bar, line, flow)</li>
<li>Low-level tools: create data visualizations & graphics from data</li>
<li>Mapping tools: create maps to various scales and with various levels of interactivity</li>
<li>Data grids: create a grid to organize data</li>
<li>3D tools: used when working in the 3rd dimension</li>
<li>Exploration apps: visualize and explore different conclusions from data</li>
</ol>

<h3>Frameworks/Languages:</h3>
<ul>
<li>React</li>
<li>Angular</li>
<li>Vue</li>
<li>Svelte</li>
</ul>

<h3>Licenses:</h3>
<ul>
<li>TypeScript</li>
<li>Open Source</li>
<li>Proprietary</li>
</ul>

<h3>Rendering:</h3>
<ul>
<li>Canvas</li>
<li>SVG</li>
<li>HTML</li>
</ul>

<h2>License</h2>
<p>MIT License</p>
<p>Copyright (C) 2021 Cube Dev, Inc.</p>

<h2>Website & Make a Suggestion</h2>
<p>Visit [awesome.cube.dev](https://awesome.cube.dev) or suggest an [improvement](https://github.com/cube-js/awesome-tools/issues).</p>