Files
docs/index.mdx
Peter Wood c6eb26037b feat: Add CI/CD setup guide with Gitea Actions for trading analysis application
feat: Implement multi-user support with separate brokerage accounts and user authentication

feat: Configure SSO authentication setup using Google OAuth 2.0 for secure access

refactor: Update index page to reflect new Trading Analysis Dashboard features and descriptions

docs: Enhance quickstart guide for deploying Trading Analysis Dashboard with detailed steps

chore: Add runner configuration for Gitea Actions with logging and container settings
2025-11-14 12:43:09 -05:00

116 lines
3.4 KiB
Plaintext

---
title: "Trading Analysis Dashboard"
description: "A comprehensive platform for analyzing trading performance and managing your investment portfolio"
---
## Welcome to Trading Analysis Dashboard
A modern, interactive web application for tracking and analyzing your stock trading performance with real-time portfolio management and comprehensive reporting.
<CardGroup cols={2}>
<Card
title="Quick Start"
icon="rocket"
href="/quickstart"
>
Get up and running in minutes with our quick start guide
</Card>
<Card
title="Portfolio Management"
icon="chart-line"
href="/features/portfolio-management"
>
Track your holdings with real-time price updates from Finnhub
</Card>
<Card
title="Trading Analysis"
icon="magnifying-glass-chart"
href="/features/trading-analysis"
>
Analyze monthly trading performance and track P&L
</Card>
<Card
title="API Reference"
icon="code"
href="/api-reference/introduction"
>
Integrate with our comprehensive RESTful API
</Card>
</CardGroup>
## Key Features
<AccordionGroup>
<Accordion title="📊 Portfolio Tracking" icon="chart-pie">
Track your stock, ETF, and mutual fund holdings with real-time price updates from Finnhub. View allocation charts, performance metrics, and gain/loss analysis.
</Accordion>
<Accordion title="📈 Trading Analysis" icon="chart-line">
Analyze monthly trading performance with detailed P&L breakdowns, win/loss ratios, and trade-by-trade analysis. View comprehensive reports with dividend tracking.
</Accordion>
<Accordion title="🔐 Secure Authentication" icon="lock">
Google OAuth 2.0 integration with user-specific data isolation. Support for multiple users with separate brokerage accounts.
</Accordion>
<Accordion title="📁 CSV Upload" icon="file-csv">
Easy CSV import with drag-and-drop support. Real-time processing feedback and upload history tracking.
</Accordion>
<Accordion title="🚀 Docker Deployment" icon="docker">
Complete Docker Compose setup with PostgreSQL database, Caddy reverse proxy, and automatic HTTPS with Let's Encrypt.
</Accordion>
<Accordion title="⚙️ CI/CD Ready" icon="robot">
Full Gitea Actions workflow for automated testing, building, and deployment with security scanning and rollback capabilities.
</Accordion>
</AccordionGroup>
## Technology Stack
<CardGroup cols={3}>
<Card title="Flask" icon="python">
Python web framework
</Card>
<Card title="PostgreSQL" icon="database">
Relational database
</Card>
<Card title="Docker" icon="docker">
Containerization
</Card>
<Card title="Caddy" icon="server">
Reverse proxy & HTTPS
</Card>
<Card title="Finnhub" icon="chart-candlestick">
Real-time market data
</Card>
<Card title="OAuth 2.0" icon="shield-check">
Secure authentication
</Card>
</CardGroup>
## Getting Started
<Steps>
<Step title="Prerequisites">
Install Docker and Docker Compose, and obtain a Finnhub API key
</Step>
<Step title="Clone & Configure">
Clone the repository and set up your environment variables
</Step>
<Step title="Deploy">
Run the deployment script to start all services
</Step>
<Step title="Upload Data">
Import your trading data via CSV upload
</Step>
</Steps>
<Card
title="Ready to dive in?"
icon="book-open"
href="/quickstart"
>
Check out our comprehensive quickstart guide to get your dashboard running in minutes
</Card>