Skip to main content

Trading Assistant Documentation

Welcome to the Trading Assistant documentation portal! This site provides comprehensive documentation for the entire application.

Documentation Structure​

Our documentation is organized into three main sections:

Architecture Documentation​

High-level architecture, design patterns, and project organization. You're currently viewing this section.

UI Components (Storybook)​

Interactive documentation for all UI components with live examples and controls.

View UI Components →

API Reference (TypeDoc)​

Auto-generated API documentation from TypeScript code, covering services, stores, types, and utilities.

View API Reference →

  • Development Guide: Learn how to set up and run the project
  • Component Library: Browse all available UI components
  • Architecture: Understand the application structure
  • Contributing: Guidelines for contributing to the project

Technology Stack​

  • Frontend: SvelteKit 2.0
  • Styling: Tailwind CSS
  • Type Safety: TypeScript
  • Backend: Supabase (PostgreSQL + Auth + Storage)
  • Deployment: VPS with Nginx

Getting Started​

# Install dependencies
npm install

# Start development server
npm run dev

# Run Storybook
npm run storybook

# Build all documentation
npm run docs:build

Project Status​

This is an active development project with continuous improvements to the UI, features, and documentation.