# SciChart.js Demo, Examples, Tutorials and Boilerplates

## What's in this repo?

1. The source code for [scichart.com/demo](https://www.scichart.com/demo) found under the **[/Examples](Examples)** folder
2. Source code for **tutorials** for SciChart.js, found under the **[/Tutorials](Tutorials)** folder;
   also examples for testing and profiling memory usage at **[/Tutorials/MemoryTests](Tutorials/MemoryTests)**
3. Ready to run starter projects for React, Angular, Vue, Electron, Next.js, Nuxt.js any many more in the **[/Boilerplates](Boilerplates)** folder
4. Standalone examples of customisations and solutions created in response to customer requests in the **[/Sandbox/CustomerExamples](Sandbox/CustomerExamples)** folder
5. Supporting code for the **v3 documentation**, which is published online at [www.scichart.com/documentation/js/current](https://www.scichart.com/documentation/js/current/webframe.html) is found in the **[/Documentation](Documentation)** folder. Source for **[v4 Documentation](https://www.scichart.com/documentation/js/v5/intro/)** is now in its own repo [scichart.js.docs](https://github.com/abtsoftware/scichart.js.docs)
6. **Advanced Licensing** technical details for customers needing to deploy to unknown or localhost domains in the **[/AdvancedLicensing](AdvancedLicensing)** folder. Further documentation on this is at [Deploying SciChart.js with Advanced Licensing (OEM)](https://www.scichart.com/documentation/js/v5/user-manual/licensing-scichart-js/deploying-with-advanced-licensing/).

> **Scroll down for how to compile the demo app, find tutorials and boilerplate examples**

## License

> [SciChart.js](https://scichart.com/javascript-chart-features) is commercial software with a **[FREE Community Edition](https://www.scichart.com/community-licensing/)**!
>
> Anything in [this Repository](https://github.com/abtsoftware/scichart.js.examples) is covered by MIT license - meaning you can freely use our example/demo/tutorial code in your applications.
>
> **SciChart.js Licensing Links**
>
> - [Find out who can use the **FREE Community license** here](https://www.scichart.com/community-licensing/)
>   - Academic usage, universities and schools, non-profits and bloggers/course-writers qualify for the free community license.
>   - Commercial trials for a reasonable time period may use the free community license.
>   - Community licensing is granted as-is without tech support, but we welcome feedback & bug reports via our [forums](https://www.scichart.com/questions).
> - [Read about SciChart's **commercial license terms** here](https://www.scichart.com/scichart-eula)
> - [**Purchase commercial licenses** plus technical support here](https://store.scichart.com)

## Useful links

> We've prepared a short [Getting Started guide](https://scichart.com/getting-started/scichart-javascript) for SciChart.js here.
>
> This will walk you through the entire process of getting started in React, Vue, Angular or just pure JS and show you where tutorials and documentation are and examples.
>
> Other useful links below:
>
> - [Changelog for SciChart.js Library](https://www.scichart.com/changelog/scichart-js/)
> - [Video Tutorials](https://www.scichart.com/documentation/js/v5/get-started/tutorials-js-npm-webpack/tutorial-01-setting-up-npm-project-with-scichart-js/)
> - [SciChart.js Documentation](https://www.scichart.com/documentation/js/v5/intro/)
> - [SciChart Community forums](https://scichart.com/questions)
> - [SciChart Stackoverflow tag](https://stackoverflow.com/tags/scichart)
> - [Contact Us (Technical support or sales)](https://scichart.com/contact-us)

# Using the SciChart.Js.Examples Repository

## [/Examples Folder](Examples)

Contains the source for the demo app for SciChart.js viewable online at [demo.scichart.com](https://demo.scichart.com).

[![SciChart.js Demo - JavaScript Chart library](https://www.scichart.com/wp-content/uploads/2022/12/scichart-js-demo-home-scaled.jpg)](https://demo.scichart.com)

After cloning the repo, open the [/Examples](Examples) folder in WebStorm or VSCode.

```shell
cd examples
npm install
npm run dev // run in dev mode
..
npm run build
npm start // run in prod mode
```

Further instructions can be found in **[/Examples/Readme.md](Examples)**

# [/Tutorials Folder](Tutorials)

Contains Tutorials for 2D & 3D Charts using npm & webpack, or vanilla js (no bundler). Video tutorials are also available online.

Further instructions can be found in **[/Tutorials/Readme.md](Tutorials)**

# [/Boilerplates Folder](Boilerplates)

Contains a number of boilerplate examples to help you get started fast using SciChart.js.

Here you can find boilerplates for React, Vue.js, Angular, Next.js, Nuxt.js, Electron and more. Each one has a readme explaining how to get started

# [/Documentation Folder](Documentation)

The [/Documentation](Documentation) folder contains supporting code and project files for us to deploy accurate, working documentation code samples for SciChart.js v3. We recommend viewing the documentation online at [scichart.com/javascript-chart-documentation](https://scichart.com/javascript-chart-documentation).

However, you can browse into [/Documentation](Documentation) and start the project if you want to browse 100s of mini code samples that are hosted throughout the docs.

Source for **[v4 Documentation](https://www.scichart.com/documentation/js/v5/intro/)** is now in its own repo [scichart.js.docs](https://github.com/abtsoftware/scichart.js.docs)