README

TradeX-chart is a highly customizable stock trade chart with one dependency written in plain JavaScript; use it with any framework or backend.

Table of Contents

• Demo
• Getting Started
• Documentation
• Features
• License

Demo

Live Demo

Getting Started

Requirements

TradeX-chart targets browsers that support ECMAScript 2022.

Install

NPM

npm install tradex-chart

In Browser

How to Use

Minimal working example:

<div id="myChartDiv"></div>

TypeScript

Types provided

Documentation

Documentation can be found here: Documentation

or built and run locally from the repository by running:

git clone https://github.com/tradex-app/TradeX-chart
cd ./tradex-chart/src/docs
npm run build

Editable Live Sandbox Examples

Editable sandbox examples can found on CodeSandbox.io

Framework Integration Examples

• React / NextJS
• Vue (TODO:)
• Svelte (TODO:)

Features

• Plain JavaScript with no framework dependencies
• All chart features and functions accessible via API
• State object defines chart configuration, indicators and tools
• State can be imported or exported for storage and retrieval
• Indicator calculation provided by talib-web as a WebAssembly module.
• Custom Themes
• Custom Indicators
• Custom Overlays
• Custom Drawing Tools (to be implemented)
• Event Hub - subscribe to chart events
• Rendering Optimization - smooth performance
• High frequency chart candles updates
• Export chart to png, jpg, webp, with optional watermarking

Support

For the latest news on TradeX-chart, feedback, feature requests, and community, join us over on Discord or GitHub.

• TradeX Discord
• Issue Tracker
• GitHub

Contributing

Testing, bug reports and feature requests welcome

If anybody you have any bugs/issues/feature requests, please, before making a submission, first:

• check the GitHub issue tracker: https://github.com/tradex-app/TradeX-chart/issues
• documentation: https://tradex-app.github.io/TradeX-chart/
• live examples: https://tradex-chart.guildmedia.net/examples/static_chart/
• development roadmap: https://github.com/tradex-app/TradeX-chart/blob/master/docs/TradeX-chart-Development-Roadmap.pdf

To submit an issue:

• Fork the chart repostitory
• Create your Feature Branch git checkout -b feature/AmazingFeature
• Commit your Changes git commit -m 'Add some AmazingFeature'
• Push to the Branch git push origin feature/AmazingFeature
• Open a Pull Request

You can help speed up development by contributing with crypto or PayPal.

if (youEnjoyed) {
    starThisRepository();
}