Skip to main content

​
Welcome Developers

This section is for developers who want to contribute to boop network or run the system locally for development and testing purposes.
Are you a vendor looking to integrate boop? You probably want the main Documentation section instead, which covers integrating with our hosted dev and production environments.

​
What You’ll Find Here

Local Development

Set up boop network on your local machine for development

System Architecture

Understand the technical architecture and system design

Docker Setup

Run the entire boop network using Docker Compose

Contributing

Guidelines for contributing code to boop network

​
Development vs Vendor Integration

Purpose: Run boop network services on your local machineWhen to use:
  • Contributing code to boop network
  • Testing system modifications
  • Learning how boop works internally
  • Debugging system issues
What you get:
  • Full boop network stack running locally
  • Mock services for testing
  • Development tools and debugging
  • Ability to modify source code
Purpose: Integrate your application with hosted boop servicesWhen to use:
  • Building a vendor application
  • Integrating boop authentication
  • Production deployment
What you get:
  • Access to hosted dev.app.boop.it environment
  • Production-ready app.boop.it environment
  • SDK and API documentation
  • WebSocket integration guides

​
Development Workflow

1

Environment Setup

Install prerequisites and clone the repository→ Local Development Setup
2

Run Services

Start all boop network services using Docker→ Docker Setup
3

Understand Architecture

Learn how the system components interact→ System Architecture
4

Start Contributing

Follow contribution guidelines and submit changes→ Contributing Guide

​
Tech Stack

Backend

  • Rust for core services
  • PostgreSQL for data storage
  • gRPC for service communication
  • WebSockets for real-time updates

Cryptography

  • Multi-Party Computation for biometric data
  • Threshold cryptography for key management
  • Zero-knowledge proofs for privacy
  • AES encryption for data at rest

Infrastructure

  • Docker for containerization
  • Kubernetes for orchestration
  • Redis for caching and sessions
  • Prometheus for monitoring

​
Quick Start

Get boop network running locally in under 10 minutes: 
# Clone the repository
git clone https://github.com/boop-network/boop-network.git
cd boop-network

# Start all services with Docker
cd docker/standalone
docker-compose up -d

# Verify everything is running
curl http://localhost:40401/health
Services Running: API Gateway at http://localhost:40401

​
Development Ports

When running locally, services are available on these ports:
ServicePortURLPurpose
API Gateway40401http://localhost:40401Main API endpoint
PVS Web Interface8081http://localhost:8081Palm scanner control
Mock Vendor8080http://localhost:8080Test vendor interface
Mock User Interface3000http://localhost:3000User registration
PostgreSQL5432localhost:5432Database
Redis6379localhost:6379Cache and sessions

​
Development Tools

  • Structured logging with tracing crate
  • Log aggregation in development mode
  • Database query logging for debugging
  • Performance profiling with pprof
  • Unit tests for individual components
  • Integration tests for service interactions
  • End-to-end tests for complete workflows
  • Mock services for isolated testing
  • Hot reload for code changes
  • Database migrations with sqlx
  • API documentation generation
  • Load testing tools

​
Getting Help

Issues & Bugs

Report bugs and request features on GitHub

Discussions

Ask questions and discuss development topics

Contributing

Learn how to contribute code and documentation

Troubleshooting

Solutions for common development issues
Ready to start developing? Begin with Local Development Setup to get your environment ready.