Skip to main content

โšก Installation Guide

Quick installation guide for the BLGV Bitcoin-native ecosystem.

๐ŸŽฏ Choose Your Installationโ€‹

# Clone repository
git clone https://github.com/BlockSavvy/Unified-Treasury-System.git
cd Unified-Treasury-System

# Start regtest environment
cd regtest-ecosystem
./start-regtest.sh

# Access platforms
# Treasury: http://localhost:3001
# DEX: http://localhost:3002
# Pool: http://localhost:3003
# API: http://localhost:3004

๐Ÿณ Docker Installationโ€‹

# Install Docker & Docker Compose
# macOS
brew install docker docker-compose

# Ubuntu/Debian
sudo apt update
sudo apt install docker.io docker-compose

# Start ecosystem
docker-compose up -d

๐Ÿ“ฆ Manual Installationโ€‹

Prerequisitesโ€‹

# Node.js 20+
nvm install 20
nvm use 20

# Python 3.11+
python3 --version

# PostgreSQL
brew install postgresql # macOS
sudo apt install postgresql # Ubuntu

Platform Installationโ€‹

# Treasury Platform
cd platforms/treasury
npm install
npm run build
npm start

# DEX Platform
cd platforms/dex
npm install
npm run build
npm start

# Mining Pool
cd platforms/pool
pip install -r requirements.txt
python app.py

# Mobile App
cd platforms/blgv-wallet-app
npm install
npx expo start

๐Ÿ”ง Configurationโ€‹

Environment Variablesโ€‹

# Copy environment templates
cp .env.example .env
cp platforms/treasury/.env.example platforms/treasury/.env
cp platforms/dex/.env.example platforms/dex/.env

# Edit with your values
DATABASE_URL=postgresql://user:pass@localhost:5432/blgv
BITCOIN_NETWORK=regtest
BTCPAY_SERVER_URL=http://localhost:14142

Database Setupโ€‹

-- Create database
CREATE DATABASE blgv_ecosystem;

-- Create schemas
CREATE SCHEMA treasury;
CREATE SCHEMA dex;
CREATE SCHEMA pool;
CREATE SCHEMA shared;

-- Run migrations
npm run migrate

โœ… Verificationโ€‹

Health Checksโ€‹

# Check all services
curl http://localhost:3001/health # Treasury
curl http://localhost:3002/health # DEX
curl http://localhost:3003/health # Pool
curl http://localhost:3004/health # API

# Expected response
{
"status": "healthy",
"timestamp": "2024-01-01T00:00:00.000Z",
"version": "1.0.0"
}

Test Connectivityโ€‹

# Test database connection
npm run db:test

# Test Bitcoin node
npm run btc:test

# Test Lightning node
npm run ln:test

๐Ÿšจ Troubleshootingโ€‹

Common Issuesโ€‹

Port Conflictsโ€‹

# Check what's using ports
lsof -i :3001 # Treasury
lsof -i :3002 # DEX
lsof -i :3003 # Pool

# Kill processes
kill -9 <PID>

Docker Issuesโ€‹

# Reset Docker
docker-compose down -v
docker system prune -f
docker-compose up -d

Database Connectionโ€‹

# Check PostgreSQL status
brew services list | grep postgresql # macOS
systemctl status postgresql # Linux

# Reset database
DROP DATABASE blgv_ecosystem;
CREATE DATABASE blgv_ecosystem;

๐Ÿ“ฑ Mobile Setupโ€‹

iOS Developmentโ€‹

# Install Xcode
# Install iOS Simulator

cd platforms/blgv-wallet-app
npx expo run:ios

Android Developmentโ€‹

# Install Android Studio
# Setup Android emulator

cd platforms/blgv-wallet-app
npx expo run:android

Physical Device Testingโ€‹

# Get your local IP
ipconfig getifaddr en0 # macOS
hostname -I | awk '{print $1}' # Linux

# Update mobile environment
EXPO_PUBLIC_API_BASE_URL=http://YOUR_IP:3004

๐Ÿ” Security Setupโ€‹

SSL Certificates (Production)โ€‹

# Generate certificates
openssl req -x509 -newkey rsa:4096 -keyout key.pem -out cert.pem -days 365

# Update configuration
HTTPS_ENABLED=true
SSL_CERT_PATH=/path/to/cert.pem
SSL_KEY_PATH=/path/to/key.pem

API Keysโ€‹

# Generate secure API keys
node -e "console.log(require('crypto').randomBytes(32).toString('hex'))"

# Set in environment
BLGV_API_KEY=your-generated-key
BTCPAY_API_KEY=your-btcpay-key

๐Ÿš€ Next Stepsโ€‹

  1. Development Setup - Full dev environment
  2. Environment Secrets - Configure all secrets
  3. Quick Start - Architecture overview
  4. Platform Guides - Platform-specific documentation

๐Ÿ“ž Supportโ€‹