Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.openbook.to/llms.txt

Use this file to discover all available pages before exploring further.

​
Prerequisites

Before you begin, make sure you have the following installed:
  • Docker & Docker Compose
  • Python 3.10+
  • Node.js 18+

​
Quick Start

1

Clone the repository

git clone <repo-url>
cd openbook
2

Start the database

docker-compose up -d db
3

Run the Backend

cd backend
python -m venv venv
source venv/bin/activate  # On Windows: venv\Scripts\activate
pip install -r requirements.txt
uvicorn app.main:app --reload
4

Run the Frontend

cd frontend
npm install
npm run dev
5

Access the applications

​
Project Structure

openbook/
├── backend/              # FastAPI Application
│   ├── app/
│   │   ├── api/          # REST Endpoints
│   │   ├── core/         # Config & Security
│   │   ├── db/           # Database setup
│   │   ├── models/       # SQLModel schemas
│   │   ├── schemas/      # Pydantic DTOs
│   │   └── services/     # Business Logic
│   └── tests/
├── frontend/             # Next.js Application
│   ├── app/              # App Router pages
│   └── public/           # Static assets
├── plan/                 # Project Documentation
└── docker-compose.yml    # Local development setup

​
Next Steps

Features Overview

Explore all OpenBook capabilities