https://github.com/arction/lcjs-analysis

A data analysis library.
https://github.com/arction/lcjs-analysis

data-analysis javascript-library lcjs lightningchart-js typescript-library

Last synced: about 1 month ago
JSON representation

A data analysis library.

• Host: GitHub
• URL: https://github.com/arction/lcjs-analysis
• Owner: Arction
• License: mit
• Created: 2019-09-19T20:53:42.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2023-03-03T11:36:56.000Z (almost 2 years ago)
• Last Synced: 2024-11-08T22:40:51.789Z (about 2 months ago)
• Topics: data-analysis, javascript-library, lcjs, lightningchart-js, typescript-library
• Language: TypeScript
• Homepage: https://arction.github.io/lcjs-analysis/
• Size: 1.11 MB
• Stars: 3
• Watchers: 4
• Forks: 0
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# LCJS data analysis tools

A collection of technical analysis tools for trading, finance, investing. Calculates Technical Indicators from data.

Designed to work directly with LightningChart® JS charting library. [https://www.arction.com/](https://www.arction.com/)

## Installation

`npm install --save @arction/lcjs-analysis`

## Documentation

Online documentation is available at [arction.github.io/lcjs-analysis](https://arction.github.io/lcjs-analysis/)

## Getting started

```

import { simpleMovingAverage } from '@arction/lcjs-analysis'

...

```

## Development instructions

The project is developed using TypeScript. Build system of the project heavily relies on Node.js. Dependencies are managed with *npm*, therefore, remember to run **npm install** before starting of anything else. 

The project uses RollUp for creating the distributable library files.

There are several *npm scripts*, which are used in development process:

| Name     | Command          | Description              |

| ---------|------------------|--------------------------|

| test     | npm test         | run tests and watch      |

| lint     | npm run lint     | run static analyzer and watch

| ci:test  | npm run ci:test  | run tests once

| ci:lint  | npm run ci:lint  | run static analyzer once

| ci:watch | npm run ci:watch | run CI circle and watch

| build    | npm run build    | build the library

| build:watch| npm run build:watch | build the library and watch

| docs     | npm run docs     | build documentation