ZippyCoin v1.0.0 - Universal Blockchain Platform

Deploy ZippyCoin on any hardware - from single machines to global networks

🚀 Quick Start

One-Line Install

curl -fsSL https://raw.githubusercontent.com/ZippyCoin-org/core/main/install.sh | bash

Manual Install

git clone https://github.com/ZippyCoin-org/core.git
cd core
./install.sh

📦 What's Included

This release contains pre-compiled binaries and Docker images only - no source code is included to protect intellectual property until patents are filed.

Pre-compiled Binaries (/binaries/)

Component	Purpose	Platforms	Download Size
zippycoin-node	Full blockchain node with RPC	Linux, macOS, Windows	~15MB
zippycoin-validator	Validator node for consensus	Linux, macOS, Windows	~12MB
zippycoin-wallet-cli	Command-line wallet	Linux, macOS, Windows	~8MB
trust-engine	Privacy scoring service	Linux, macOS, Windows	~20MB
api-gateway	GraphQL API server	Linux, macOS, Windows	~18MB

Docker Images

Pre-built Docker images available on Docker Hub:

• zippycoin/core:latest - Full node
• zippycoin/validator:latest - Validator
• zippycoin/trust-engine:latest - Trust scoring
• zippycoin/api-gateway:latest - API server
• zippycoin/wallet-service:latest - Wallet backend

Quick Start Options

Option 1: Docker (Recommended)

# Pull and run full node
docker run -d -p 8545:8545 -p 30303:30303 zippycoin/core:latest

# Run with monitoring
docker run -d -p 9090:9090 zippycoin/monitoring:latest

Option 2: Direct Binary Download

# Download appropriate binary for your platform
# Linux: zippycoin-node-linux-amd64
# macOS: zippycoin-node-darwin-amd64
# Windows: zippycoin-node-windows-amd64.exe

# Make executable and run
chmod +x zippycoin-node-linux-amd64
./zippycoin-node-linux-amd64 --help

🖥️ Supported Platforms

Platform	Status	Minimum Requirements
Linux	✅ Full Support	Ubuntu 18.04+, 2GB RAM, 10GB disk
macOS	✅ Full Support	macOS 10.15+, 4GB RAM, 10GB disk
Windows	🔄 Coming Soon	WSL2 required
Raspberry Pi	✅ Supported	4GB RAM model recommended
Cloud VMs	✅ Full Support	AWS, GCP, Azure, DigitalOcean

📋 System Requirements

Minimum (Single Node)

• CPU: 2 cores
• RAM: 2GB
• Storage: 10GB SSD
• Network: 10Mbps internet

Recommended (Multi-Node)

• CPU: 4+ cores
• RAM: 8GB+
• Storage: 50GB+ SSD
• Network: 100Mbps+ internet

🛠️ Manual Setup

1. Install Dependencies

Ubuntu/Debian:

sudo apt update
sudo apt install -y curl wget git build-essential

macOS:

# Install Homebrew if needed
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"

brew install curl wget git node@18 docker

CentOS/RHEL/Fedora:

sudo yum install -y curl wget git gcc gcc-c++ make
# or
sudo dnf install -y curl wget git gcc gcc-c++ make

2. Install Node.js (18+)

Using NodeSource (Linux):

curl -fsSL https://deb.nodesource.com/setup_18.x | sudo -E bash -
sudo apt-get install -y nodejs

Using Homebrew (macOS):

brew install node@18

3. Install Docker

Linux:

curl -fsSL https://get.docker.com -o get-docker.sh
sudo sh get-docker.sh
sudo usermod -aG docker $USER

macOS:

brew install --cask docker

4. Clone and Run

git clone https://github.com/ZippyCoin-org/core.git
cd core
npm install
npm run setup

🚀 Running ZippyCoin

Quick Start (Recommended)

# Clone the repository
git clone https://github.com/ZippyCoin-org/core.git
cd core

# Start the complete network
./scripts/setup-network.sh

This starts:

• Full Node: RPC API on port 8545
• Trust Engine: Privacy scoring on port 3000
• API Gateway: GraphQL API on port 4000
• Monitoring: Prometheus (9090) + Grafana (3001)

Manual Docker Setup

# Start all services
docker-compose up -d

# Check status
docker-compose ps

# View logs
docker-compose logs -f

Stop the Network

docker-compose down

📊 Monitoring & Management

Once running, access:

• Trust Engine API: http://localhost:3000/health
• API Gateway (GraphQL): http://localhost:4000/graphql
• Prometheus Monitoring: http://localhost:9090
• Grafana Dashboard: http://localhost:3001 (admin/zippycoin)

Test the APIs

# Check trust engine
curl http://localhost:3000/health

# Check API gateway
curl http://localhost:4000/health

# Query GraphQL API
curl -X POST http://localhost:4000/graphql \
  -H "Content-Type: application/json" \
  -d '{"query": "{ network }"}'

🔧 Configuration

Environment Variables

# Network configuration
ZIPPYCOIN_NETWORK=mainnet|testnet|devnet
ZIPPYCOIN_PORT=8545
ZIPPYCOIN_DATA_DIR=/data/zippycoin

# Performance tuning
ZIPPYCOIN_MAX_PEERS=50
ZIPPYCOIN_CACHE_SIZE=512MB

Docker Compose Override

version: '3.8'
services:
  blockchain:
    environment:
      - ZIPPYCOIN_NETWORK=testnet
    volumes:
      - ./data:/data/zippycoin

🏘️ Network Deployment

Genesis Node Setup

./scripts/setup-genesis.sh

Add Validator Nodes

./scripts/add-validator.sh --ip <validator-ip>

Scale to Multiple Nodes

./scripts/scale-network.sh --nodes 10

🛡️ Security

• Validator Keys: Secure key management with hardware security modules
• Network Security: TLS encryption and certificate pinning
• Access Control: Role-based permissions and API authentication
• Monitoring: Real-time security event monitoring

📚 Documentation

• Architecture Overview
• API Reference
• Deployment Guide
• Troubleshooting

🤝 Contributing

1. Fork the repository
2. Create a feature branch
3. Make your changes
4. Add tests
5. Submit a pull request

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

🆘 Support

• Documentation: docs.zippycoin.io
• Discord: Join our community
• Issues: GitHub Issues
• Discussions: GitHub Discussions

🚀 Roadmap

• Windows native support
• Mobile wallet apps
• Hardware wallet integration
• DeFi protocol expansion
• Cross-chain bridges
• Enterprise features

---

Built with ❤️ by the ZippyCoin Community

Empowering financial freedom through decentralized technology