Development Setup
Prerequisites
Section titled “Prerequisites”- Bun (package manager and runtime)
- Docker (for backend services, optional)
- D2 (for diagram rendering, optional)
Quick Start
Section titled “Quick Start”- Clone the repository
git clone https://github.com/salazarsebas/stellar-explorer.gitcd stellar-explorer- Install dependencies
bun install- Start the development server
bun run devThe explorer will be available at http://localhost:3000.
Backend Services (Optional)
Section titled “Backend Services (Optional)”For indexer functionality, start the Docker services:
docker compose up -dThis starts PostgreSQL (port 54320), Redis (port 63790), and Typesense (port 18108).
Environment Variables
Section titled “Environment Variables”Copy the example file and adjust if needed:
cp .env.local.example .env.localAvailable Commands
Section titled “Available Commands”| Command | Purpose |
|---|---|
bun run dev | Start development server (port 3000) |
bun run build | Production build |
bun run lint | Run ESLint |
bun run format | Format code with Prettier |
bun run test | Run tests |
bun run test:watch | Run tests in watch mode |