🚀 Quick Setup
📋 Prerequisites
Node.js 18+
Required for frontend development and smart contract tools
Go 1.21+
Backend API server development
Docker & Docker Compose
Containerization and development environment
Git
Version control and repository management
⚡ Option 1: Automated Setup (Recommended)
# Make setup script executable (Linux/macOS)
chmod +x setup.sh
./setup.sh
# Or run manually on Windows
bash setup.sh🔧 Option 2: Manual Setup
# 1. Install dependencies
make install
# 2. Copy environment configuration
cp .env.example .env
# Edit .env file with your settings
# 3. Start development services
make dev🏃♂️ Running the Application
🐳 Option A: Using Docker (Easiest)
This method automatically handles all dependencies and services
# Start all services
make docker-up
# Access the applications:
# - Frontend: http://localhost:3000
# - Backend API: http://localhost:8080
# - Local Blockchain: http://localhost:8545⚙️ Option B: Individual Services
Requires multiple terminal windows and manual dependency management
# Terminal 1: Start database services
docker-compose up -d postgres redis
# Terminal 2: Smart contracts (local blockchain)
cd contracts
npm run node
# Terminal 3: Backend API
cd backend
go run cmd/server/main.go
# Terminal 4: Frontend DApp
cd frontend
npm run dev🔧 Essential Commands
🏗️ Build Everything
make build🧪 Run Tests
make test🧹 Clean Build Artifacts
make clean🛑 Stop All Services
make docker-down📁 Project Structure
🌐 Default URLs
🔑 Environment Configuration
# Blockchain
ETHEREUM_RPC_URL=https://mainnet.infura.io/v3/YOUR_PROJECT_ID
SEPOLIA_RPC_URL=https://sepolia.infura.io/v3/YOUR_PROJECT_ID
PRIVATE_KEY=your-deployer-private-key
# Security
JWT_SECRET=your-secure-jwt-secret
# Database
DATABASE_URL=postgresql://user:password@localhost:5432/netvet
# API Configuration
API_PORT=8080
API_HOST=localhost🧪 Testing
🔍 Run All Tests
make test📜 Smart Contract Tests
cd contracts && npm run test⚛️ Frontend Tests
cd frontend && npm run test🐹 Backend Tests
cd backend && go test ./...📦 Deployment
See DEPLOYMENT_GUIDE.md for detailed deployment instructions.
🚀 Deploy Smart Contracts
cd contracts && npm run deploy🏗️ Build for Production
make build-prod🐳 Docker Deployment
docker-compose -f docker-compose.prod.yml up -d☁️ Cloud Deployment
./deploy.sh production🆘 Troubleshooting
🔧 Common Issues
- Port conflicts Change ports in docker-compose.yml if you have conflicts with existing services
-
Dependencies not found
Run
make installto reinstall all dependencies - Docker permission errors Ensure Docker has proper permissions and is running
- Environment issues Check .env file configuration and ensure all required variables are set
- Blockchain connection failed Verify RPC URLs in .env and check network connectivity
🤝 Getting Help
📚 Documentation
Check the docs/ directory for detailed documentation
🐛 GitHub Issues
Create an issue on GitHub if you encounter bugs
💬 Community Discord
Join our community Discord for real-time support
📧 Contact Support
Email support@netvet.xyz for technical assistance
🎯 Next Steps
Configure Environment
Update .env with your specific configuration
Deploy Smart Contracts
Run cd contracts && npm run deploy
Explore the Codebase
Familiarize yourself with the project structure
Read Documentation
Check the full documentation in docs/
Start Building
Begin developing your veterinary DApp!
Join the Community
Connect with other developers and get support
🎉 Happy coding!
You're now ready to build amazing DeFi security solutions with NetVet Protocol