Skip to content

QuantAlchemy/quant-companion

Repository files navigation

TradingView Companion

A powerful tool for analyzing and optimizing TradingView strategy results. This application allows you to export strategy data from TradingView and perform in-depth analysis of your trading performance.

Features

  • Import multiple TradingView strategy export files for portfolio analysis
  • Comprehensive performance metrics and visualizations
  • Web extension support for seamless integration with TradingView
  • Future support for automatic strategy optimization and parameter analysis

Getting Started

Prerequisites

  • Node.js (v20 or higher)
  • pnpm package manager

Installation

  1. Clone the repository:
git clone https://github.com/yourusername/tradingview-companion.git
cd tradingview-companion
  1. Install dependencies:
pnpm install

Development

Run the development server:

pnpm run dev

Open http://localhost:5173 to view it in the browser.

Building for Production

Build the app for production:

pnpm run build

The build is suitable for both web deployment and web extension use.

Usage

You can use TradingView Companion through the web application:

  1. Web Application: Visit https://www.quant-companion.quantalchemy.io/ to use the application directly in your browser.

How to Use

  1. Export your strategy data from TradingView using the built-in export functionality
  2. Upload the exported files to the TradingView Companion web application
  3. Analyze your strategy performance across multiple metrics

Resources

Contributing

Please read CONTRIBUTING.md for details on our code of conduct and the process for submitting pull requests.

License

This project is licensed under the MIT License - see the LICENSE file for details.

$ pnpm install

Learn more on the Solid Website and come chat with us on our Discord

Available Scripts

In the project directory, you can run:

pnpm run dev

Runs the app in the development mode.
Open http://localhost:5173 to view it in the browser.

pnpm run build

Builds the app for production to the dist folder.
It correctly bundles Solid in production mode and optimizes the build for the best performance.

This build is also sutitable for a deployment as a web-extension.

The build is minified and the filenames include the hashes.
Your app is ready to be deployed!

Deployment

Learn more about deploying your application with the documentations