Introduction
Understand the Gravity codebase and use this documentation set to navigate local setup, architecture, services, operations, and configuration.
Overview
Gravity is a polyglot monorepo that brings together a Remix frontend, a NestJS API, and a FastAPI AI service. This documentation set stays close to the repository so you can move from reading to running, debugging, and changing the system without guessing how the pieces fit together.
These docs are grounded in the current implementation. When a document and the repository drift, follow the repository behavior first and treat older references as suspect until they are updated.
What this documentation covers
Use these docs to get oriented quickly and then drill into the part of Gravity you need to work on. Most pages fall into one of these areas:
- Getting started for local setup, prerequisites, and first-run workflows
- Architecture for how the frontend, API, and AI services connect
- Service foundations for the core patterns, boundaries, and responsibilities inside each service
- Operations for running, configuring, and troubleshooting the system in different environments
- Reference material for configuration details, interfaces, and implementation-specific facts
Start with the shortest path that matches your goal, then follow the linked pages for deeper detail.
Quickstart
Set up the repository locally and verify that the main services start correctly.
Architecture Overview
Understand how the Remix frontend, NestJS API, and FastAPI AI service fit together.
API Service Foundation
Review the core structure, patterns, and responsibilities of the API service.
Configuration Reference
Look up environment variables, configuration surfaces, and behavior that depends on runtime settings.