Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/elastic/elastic-charts
https://github.com/elastic/elastic-charts
chart-library charts data-visualization elastic kibana visualizations
Last synced: 5 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/elastic/elastic-charts
- Owner: elastic
- License: other
- Created: 2019-01-14T11:49:41.000Z (almost 6 years ago)
- Default Branch: main
- Last Pushed: 2024-12-17T13:20:29.000Z (6 days ago)
- Last Synced: 2024-12-17T14:25:43.144Z (5 days ago)
- Topics: chart-library, charts, data-visualization, elastic, kibana, visualizations
- Language: TypeScript
- Homepage: https://elastic.github.io/elastic-charts/storybook
- Size: 889 MB
- Stars: 373
- Watchers: 287
- Forks: 122
- Open Issues: 353
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
Awesome Lists containing this project
README
Elastic Charts
Check out our [living style guide][docs], which contains many examples on how charts look and feel, and how to use them in your products or fork the [codesandbox](https://codesandbox.io/p/sandbox/elastic-charts-playground-gmnjx9?file=%2Fsrc%2FApp.tsx) example here to play directly with the library.
## Installation
To install the Elastic Charts into an existing project, use the `yarn` CLI (`npm` is not supported).
```
yarn add @elastic/charts
```
> **Important:** see the [consuming] wiki for detailed installation requirements
## Running Locally
### Node
We depend upon the version of node defined in [.nvmrc](.nvmrc).
You will probably want to install a node version manager. [nvm](https://github.com/creationix/nvm) is recommended.
To install and use the correct node version with `nvm`:
```
nvm install
```
### Development environment
You can run the dev environment locally at [http://localhost:9001](http://localhost:9001/) by running:
```
yarn
yarn start
```
We use [storybook](https://storybook.js.org) to document API, edge-cases, and the usage of the library.
A hosted version is available at [https://elastic.github.io/elastic-charts/storybook][docs].
## Goals
The primary goal of this library is to provide reusable set of chart components that can be used throughout Elastic's web products.
As a single source of truth, the framework allows our designers to make changes to our look-and-feel directly in the code. And unit test coverage for the charts components allows us to deliver a stable "API for charts".
## Contributing
You can find documentation around creating and submitting new features in [contributing][contributing].
## [Wiki][wikiroot]
### Consumption
- [Consuming Elastic Charts][consuming]
### Documentation
- [Overview][overview]
- [Theming][theming]
## License
[Dual-licensed under Elastic v2 and Server Side Public License, v 1][license] Read the [FAQ][faq] for details.
[license]: LICENSE.txt
[wikiroot]: https://github.com/elastic/elastic-charts/wiki
[faq]: https://github.com/elastic/elastic-charts/wiki/FAQ
[docs]: https://elastic.github.io/elastic-charts/storybook/
[consuming]: https://github.com/elastic/elastic-charts/wiki/Consuming-@elastic-charts
[overview]: https://github.com/elastic/elastic-charts/wiki/Overview
[theming]: https://github.com/elastic/elastic-charts/wiki/Theming
[contributing]: https://github.com/elastic/elastic-charts/wiki/Contributing-to-Elastic-Charts