Documentation

Browse the project documentation to learn about APIs, features, and implementation details.

Development Documentation

This section contains documentation for developers working on the Thessia project.

Getting Started

Development Workflow

Prerequisites

  • Bun runtime
  • MongoDB
  • Redis
  • Node.js 18+ (for some tools)

Quick Start

# Install dependencies
bun install

# Start development server
bun run dev

Architecture

Thessia uses a modern TypeScript stack:

  • Frontend: Nuxt with Vue and Nitro
  • Backend: Nitro server with MongoDB and Redis
  • Build System: Consolidated esbuild-based system for CLI, Cron, and Queue binaries
  • Job Processing: BullMQ for background jobs
  • Internationalization: Vue i18n with Transifex integration

Documentation Structure

docs/
├── development/          # Development documentation
│   ├── index.md         # This file
│   ├── development-guide.md  # Complete development setup
│   └── build-system.md  # Build system documentation
├── api/                 # API documentation
├── backend/             # Backend-specific docs
├── frontend/            # Frontend-specific docs
└── installation/        # Installation and deployment

Contributing

Please refer to the Development Guide for detailed information about:

  • Project structure
  • Coding conventions
  • Testing procedures
  • Deployment processes
  • Contribution guidelines