Skip to content

Getting Started¤

Welcome to the AI Goal-Seeking System! This section provides everything you need to get up and running quickly, whether you're a new contributor, reviewer, or demo participant.

Quick Navigation¤

🚀 New to the Project?¤

  • Quickstart Guide - 10-minute setup to run the demo and explore the architecture
  • Development Setup - Comprehensive setup guide for local development and demo environments
  • Troubleshooting - Common issues and solutions during setup and development

Prerequisites¤

Before getting started, ensure you have:

  • Node.js 18+ and npm (or yarn)
  • Docker (optional but recommended)
  • Git for version control
  • Platform: macOS, Linux, or Windows

Quick Setup Overview¤

graph LR
    classDef setup fill:#e8f5e8,stroke:#2e7d32,stroke-width:2px
    classDef optional fill:#fff3e0,stroke:#e65100,stroke-width:2px

    A[Clone Repository]:::setup
    B[Install Dependencies]:::setup
    C[Environment Setup]:::setup
    D[Docker Stack]:::optional
    E[Local Development]:::setup
    F[Verify Health]:::setup

    A --> B
    B --> C
    C --> D
    C --> E
    D --> F
    E --> F

Fast Track (Docker)¤

1
2
3
4
# Clone and run with Docker
git clone https://github.com/ianlintner/React.git
cd React
docker-compose up -d

Local Development¤

1
2
3
4
5
# Backend
cd backend && npm install && npm run dev

# Frontend (separate terminal)
cd frontend && npm install && npm start

What's Next?¤

After setup, explore these key areas:

  1. System Architecture - Understanding the system design and components
  2. API Documentation - Interactive Swagger UI at http://localhost:5001/docs
  3. Operations - Monitoring and observability tools
  4. Examples - Integration examples and code samples

Getting Help¤