Skip to content

base-report/chart-study

Repository files navigation

Chart Study Tool

The Chart Study tool, by base.report, is a web-based application for analyzing stock charts.

Warning: It is currently in alpha stage and may contain bugs or unfinished features.

Features

  • A frame that starts with a single pane and can be split to the right or to the bottom.
  • Each pane can hold a widget, including a stock chart, move finder, and advanced mover finder (with embedded code editor).
  • Customization options to personalize the user experience.

Chart Study tool Screenshot

Usage

For a quick start guide on how to use the tool, please watch the following video tutorial.

Watch the video tutorial

Get started

Financial Modeling Prep is used as the data provider. You can obtain an API key from their website.

Following are instructions for installing the Chart Study tool locally and on Vercel.

Local

Prerequisites

Setup environment variables

Create a .env file and add the following content. You need to fill in SECRET_FMP_API_KEY value with your own API key.

SECRET_FMP_API_URL=https://financialmodelingprep.com/api
SECRET_FMP_API_KEY=

Install and run

pnpm install
pnpm run dev

# or start the server and open the app in a new browser tab
pnpm run dev -- --open

Vercel

Prerequisites

  • A GitHub account.
  • A Vercel account that is linked with your GitHub account

Instructions

Feedback

We welcome feedback and bug reports. Please submit an issue or pull request on GitHub.

Contributing

We welcome contributions to the Chart Study tool. Please submit pull requests and issues on GitHub. As the project is currently in alpha stage, there is no set standards yet except for semantic commit messages.

Licensing

Chart Study tool is released under the MIT license. See the LICENSE file for more information.

About

The Chart Study tool, by base.report, is a web-based application for analyzing stock charts.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published