Prerequisites
- Bun (v1.2+) or Node.js 19+
- Docker and Docker Compose
- Solana CLI (for Anchor)
- Anchor (v0.32.1+)
Quick Setup
1
Clone the repository
2
Install dependencies
3
Set up environment variables
Copy example files:Edit the
.env files with your values:HELIUS_API_KEY- Get from HeliusANCHOR_WALLET- Path to your Solana keypair
4
Start infrastructure
5
Run development servers
API Server:Frontend:Anchor Program:
Project Structure
packages
anchor
api
browsers
frontend
shared
docker-compose.yml
package.json
docs
Development Workflow
- Start infrastructure:
docker compose up -d - Run API in watch mode:
cd packages/api && bun run dev - Run frontend in watch mode:
cd packages/frontend && bun run dev - Build Anchor program:
cd packages/anchor && anchor build
Access Services
- Frontend: http://localhost:3000
- API: http://localhost:3001
- API Health: http://localhost:3001/api/health
- PostgreSQL: localhost:5432
- Redis: localhost:6379
Testing
Run all tests:Troubleshooting
Docker issues
Docker issues
If Docker services fail to start:
- Check Docker is running:
docker ps - Check ports are available (3000, 3001, 5432, 6379)
- Restart Docker:
docker compose down && docker compose up -d
Anchor build errors
Anchor build errors
If Anchor build fails:
- Ensure Solana CLI is installed:
solana --version - Set Solana config:
solana config set --url devnet - Check Anchor version:
anchor --version(should be 0.32.1+)
API connection errors
API connection errors
If API can’t connect to services:
- Verify Docker services are running:
docker compose ps - Check environment variables are set correctly
- Verify Helius API key is valid
Next Steps
Contributing Guide
Learn how to contribute to the project.
Contributing Overview
Full contributing documentation.