Development Overview

Welcome to OneSearch development documentation!

Quick Links

• Contributing Guide
• Architecture
• Backend Development
• Frontend Development
• Adding File Extractors
• Testing

Tech Stack

• Backend: Python 3.10+, FastAPI, SQLAlchemy
• Frontend: React 19, TypeScript, Vite, TanStack Query, Tailwind CSS 4
• Search: Meilisearch
• Database: SQLite
• Deployment: Docker, Docker Compose

Getting Started

1. Clone the repository
2. Read Contributing Guide
3. Set up development environment
4. Pick an issue or feature to work on

Development Commands

Backend

uv sync
uv run uvicorn app.main:app --app-dir backend --reload

Frontend

cd frontend
npm install
npm run dev

Docker

docker compose up -d --build

See individual guides for detailed instructions.