Home

Celestia Indexer - Documentation Index

Welcome to the Celestia Indexer documentation. This is a comprehensive indexing solution for the Celestia blockchain written in Go.

Getting Started

New to the project? Start here:

1. Quick Start Guide - Get running in 5 minutes with Docker Compose
   • Prerequisites and initial setup
   • Basic operations and troubleshooting
   • API examples and configuration changes

Core Documentation

Understanding the System

• Architecture - How the system is designed and organized
  • High-level system design
  • Core components (Indexer, API, Storage)
  • Data flow and processing pipeline
  • Performance considerations
  • Integration points

Building & Running

• Development Guide - Local development setup
  • Prerequisites and dependencies
  • Environment configuration
  • Running services locally and with Docker
  • Testing and code quality
  • Debugging techniques
  • Troubleshooting common issues

Contributing

• Contributing Guide - How to contribute
  • Project structure overview
  • Code style and conventions
  • Contribution workflow
  • Development best practices
  • Code review checklist
  • Release process