Skip to Content
ContributeOverview

Contribute

We welcome contributions of all kinds: code, ideas, documentation, and bug reports. This section is technical documentation for developers working on and with Rhesis.

Quick start (from repo root)

./rh dev init         # env files (one-time)
./rh dev up           # postgres + redis
./rh dev backend      # API (e.g. /docs on port 8080)
./rh dev frontend     # UI at http://localhost:3000

Run ./rh help for all commands.

Full stack with Docker: ./rh start — frontend and API URLs match development setup; use ./rh logs, stop, restart, delete to manage containers.

Repository layout

  • apps/backend — FastAPI service (rhesis.backend)
  • apps/frontend — Next.js UI
  • sdk — Python SDK
  • docs — documentation site (this content)
  • tests/backend, tests/sdk — tests consumed via each package’s Makefile/pytest config

Development resources

Development Setup: Complete guide to setting up your development environment.

Development Setup

Complete guide to setting up your development environment.

Setup Guide →Backend: FastAPI backend service architecture.

Backend

FastAPI backend service architecture.

Backend Docs →Frontend: React-based frontend architecture.

Frontend

React-based frontend architecture.

Frontend Docs →API Structure: Backend REST API architecture and endpoints.

API Structure

Backend REST API architecture and endpoints.

View API Docs →SDK: Python SDK documentation.

SDK

Python SDK documentation.

SDK Docs →Coding Standards: Code style guidelines and best practices.

Coding Standards

Code style guidelines and best practices.

View Standards →Contributing: Guidelines for contributing to Rhesis.

Contributing

Guidelines for contributing to Rhesis.

Contribute →

Architecture overview

Backend Service

FastAPI-based backend service providing REST APIs, authentication, and business logic.

Frontend Application

React-based frontend with TypeScript, providing the main user interface.

Worker Service

Celery-based background task processing for long-running operations.

Chatbot Application

AI-powered chatbot for interactive testing and evaluation.

Monitoring Service

Polyphemus service for observability and monitoring.

Python SDK

Comprehensive Python SDK for integrating Rhesis into your applications.

Tests and formatting

Run make targets from the relevant app directory (see backend, SDK, and frontend topics in this section):

  • Backend (apps/backend): make test, make format, make lint, make all
  • SDK (sdk): make test (and integration flows documented there)
  • Frontend (apps/frontend): make test, make lint, etc.

Tip: ./.github/pr is available in the repo for opening pull requests if your clone includes it.

Deep dives here

Issues: GitHub  (filter by the good first issue label). Community: Discord .

Development Setup