Introduction

Welcome to Plus261 Documentation

Plus261 is a comprehensive management platform for quail farming and poultry product sales. This documentation covers all aspects of the platform, from the GraphQL API to the web client, including shared libraries.

New to Plus261?

Start with Getting Started or the short Quick Start.
Local and production runtime: Infrastructure.

What is Plus261?

Plus261 is a modern, full-stack platform built with:

• GraphQL API - Type-safe API built with Type GraphQL Query
• SvelteKit Web Client - Modern, offline-first web application
• PostgreSQL Database - Robust data storage with Drizzle ORM
• Monorepo Architecture - Shared libraries and code reuse

Platform Overview

The Plus261 platform is organized as a monorepo with the following components:

Component	Description	Documentation
🚀 API	GraphQL backend server with authentication, ACL, and comprehensive data management	API Overview
🌐 Web	SvelteKit application for the user interface	Web Overview
📚 Libraries	Shared libraries for database, GraphQL client, and more	Libraries Overview
🏗️ Architecture	System architecture and design patterns	Architecture Overview

Project Structure

plus261/
├── apps/
│   ├── api/              → GraphQL API backend
│   ├── web/              → SvelteKit web client
│   ├── auth/             → Identity provider
│   ├── ingest/           → Ingest service
│   ├── worker/           → Background workers
│   ├── device-detector/  → PHP User-Agent API
│   └── documentation/    → This documentation
├── libs/                 → Shared packages (@lib/*)
├── devops/
│   ├── k8s/app/          → Stack produit (plus261-app)
│   ├── k8s/ops/          → Stack ops (plus261-ops)
│   ├── k8s/overlays/     → k3d / k3s par stack
│   └── scripts/          → Bootstrap, nerdctl, env:init

Key Features

Plus261 provides a comprehensive set of features:

Business Features

• 🐣 Breeding Management - Tracking of incubations, locations, and populations
• 📦 Inventory Management - Stock inventory and movements
• 🛒 Orders - Complete order and billing system
• 💰 Pricing - Multi-currency pricing support
• 📊 Analytics - Business intelligence and reporting

Technical Features

• 🔐 Authentication - Robust authentication system with sessions
• 🔑 ACL - Granular access control based on permissions
• 💬 Chat & calls - Built-in messaging, item discussions, voice messages, audio/video calls (LiveKit)
• 📱 Offline-first - Offline mode support with synchronization
• 🌍 Internationalization - Multi-language support (FR, EN, MG)
• 🔍 Search - Full-text search capabilities
• 📈 Observability - Logging, metrics, and tracing

Quick Start

Choose your path:

New Developer?

Start with the Quick Start Guide for Developers to get productive in 5 minutes!

New User?

Check out the Getting Started Guide to set up the platform.

Documentation Structure

Our documentation is organized into logical sections:

Getting Started

• Getting Started - Installation and setup guide
• Quick Start (Developers) - Fast track for developers
• First Steps - First steps after installation

API Documentation

• API Overview - Introduction to the GraphQL API
• GraphQL Schema - Schema structure and types
• Queries - Query operations
• Mutations - Mutation operations
• Subscriptions - Real-time subscriptions
• Type GraphQL Query - Schema builder documentation

Web Client

• Web Overview - Web client introduction
• Architecture - Client architecture
• Components - UI components
• State Management - State management patterns

Libraries

• Libraries Overview - Shared libraries introduction
• Database (db) - Database schema and ORM
• GraphQL Client - Generated GraphQL client
• Drizzle Query - Query helpers

Guides

• Code Structure - Codebase organization
• Development - Development workflow
• Testing - Testing guide
• Debugging - Debugging techniques

Architecture

• Architecture Overview - System architecture
• Database - Database architecture
• Deployment - Deployment strategies
• Security - Security architecture

Navigation Guide

Use the sidebar to navigate the documentation:

Section	What You’ll Find
📖 Getting Started	Installation and setup guides
🚀 API	Complete GraphQL API documentation
🌐 Web	Web client documentation
📚 Libraries	Shared libraries documentation
🏗️ Architecture	System architecture and design
📘 Guides	Step-by-step guides and tutorials
📋 Reference	API reference and utilities
🔧 Advanced	Advanced topics and customization
🤝 Contributing	How to contribute to the project
🛠️ Type GraphQL Query	Schema builder documentation

Next Steps

Ready to get started? Here’s a recommended path:

1. 🚀 Getting Started - Set up the platform
2. 📊 API Overview - Understand the GraphQL API
3. 🏗️ Architecture Overview - Learn the system architecture
4. 📚 Code Structure - Understand the codebase

Related Topics

• Quick Start for Developers - Fast track setup
• API Overview - GraphQL API introduction
• Type GraphQL Query - Schema builder
• Architecture Overview - System design