Getting Started

Welcome to the Stock Screening Platform! This guide will help you get up and running quickly.

Quick Start

The fastest way to start is using Docker Compose:

# Clone the repository
git clone https://github.com/kcenon/screener_system.git
cd screener_system

# Copy environment variables
cp .env.example .env

# Start all services
docker-compose up -d

# Check service health
docker-compose ps

Access the application:

• Frontend: http://localhost:5173
• Backend API: http://localhost:8000
• API Docs: http://localhost:8000/docs
• Airflow UI: http://localhost:8080

What's Next?

• Installation Guide - Detailed setup instructions
• Architecture Overview - Understand the system
• Project Structure - Navigate the codebase

Need Help?

• Check the User Guides
• Read the API Reference
• See Troubleshooting