Skip to content

Development Setup

  • Bun (package manager and runtime)
  • Docker (for backend services, optional)
  • D2 (for diagram rendering, optional)
  1. Clone the repository
Terminal window
git clone https://github.com/salazarsebas/stellar-explorer.git
cd stellar-explorer
  1. Install dependencies
Terminal window
bun install
  1. Start the development server
Terminal window
bun run dev

The explorer will be available at http://localhost:3000.

For indexer functionality, start the Docker services:

Terminal window
docker compose up -d

This starts PostgreSQL (port 54320), Redis (port 63790), and Typesense (port 18108).

Copy the example file and adjust if needed:

Terminal window
cp .env.local.example .env.local
CommandPurpose
bun run devStart development server (port 3000)
bun run buildProduction build
bun run lintRun ESLint
bun run formatFormat code with Prettier
bun run testRun tests
bun run test:watchRun tests in watch mode