Skip to main content

Getting Started with SophiChain

Your Guide to Building on SophiChain

Welcome! This guide will help you get up and running with SophiChain quickly.

📋 Prerequisites​

Before you begin, ensure you have:

Required Software​

Required Services​

  • ✅ MongoDB 7.0+ - For document storage
  • ✅ SQL Server 2022+ or PostgreSQL 15+ - For transactional data
  • 💡 Visual Studio 2022 or VS Code with C# extension
  • 💡 MongoDB Compass - For database management
  • 💡 Postman or Insomnia - For API testing

🚀 Quick Start (5 Minutes)​

Step 1: Clone the Repository​

git clone https://github.com/sophichain.git
cd sophichain

Step 2: Start Infrastructure with Docker​

# Start MongoDB and SQL Server
docker-compose up -d

# Verify services are running
docker ps

Step 3: Configure Connection Strings​

Edit hosts/b2host/src/SophiChain.B2Host.Blazor/appsettings.json:

{
  "ConnectionStrings": {
    "Default": "Server=localhost;Database=SophiChain;User Id=sa;Password=YourPassword123!;TrustServerCertificate=true",
    "MongoDB": "mongodb://localhost:27017/SophiChain"
  }
}

Step 4: Run Database Migrations​

cd hosts/b2host/src/SophiChain.B2Host.DbMigrator
dotnet run

Step 5: Start the Application​

cd ../SophiChain.B2Host.Blazor
dotnet run

Step 6: Open Your Browser​

Navigate to: https://localhost:44300

Default Credentials:

  • Username: admin
  • Password: 1q2w3E*

🎯 What's Next?​

For Business Users​

  1. Explore FinanceHub - Understand payment capabilities
  2. Review Use Cases - See real-world scenarios
  3. Plan Your Implementation (Coming Soon)

For Developers​

  1. Architecture Overview (Coming Soon) - Understand the system design
  2. FinanceHub Deep Dive - Learn implementation patterns
  3. Build Your First Module (Coming Soon)
  4. API Reference (Coming Soon)

For DevOps​

  1. Docker Deployment (Coming Soon)
  2. Kubernetes Setup (Coming Soon)
  3. Monitoring & Logging (Coming Soon)

📚 Detailed Setup Guides​

Option 1: Development Environment (Coming Soon)​

Full local development setup with all services.

Option 2: Docker Compose (Coming Soon)​

Containerized development environment.

Option 3: Cloud Deployment (Coming Soon)​

Deploy to Azure, AWS, or ArvanCloud.

🔧 Configuration​

Module Configuration (Coming Soon)​

How to enable/disable specific modules.

Multi-Tenancy Setup (Coming Soon)​

Configure tenant isolation and management.

Payment Gateway Configuration (Coming Soon)​

Set up Stripe, PayPal, ZarinPal, etc.

AI Services Configuration (Coming Soon)​

Connect OpenAI, DeepSeek, or local models.

🧪 Running Tests​

# Run all tests
dotnet test

# Run specific module tests
cd modules/sophichain.financehub/test
dotnet test

# Run with coverage
dotnet test --collect:"XPlat Code Coverage"

🐛 Troubleshooting​

Common Issues (Coming Soon)​

Solutions to frequently encountered problems.

Database Connection Issues (Coming Soon)​

Fix connection string problems.

Port Conflicts (Coming Soon)​

Resolve port binding issues.

💡 Learning Resources​

Video Tutorials (Coming Soon)​

  • Getting Started (10 min)
  • Building Your First Module (30 min)
  • Payment Integration (20 min)

Sample Projects (Coming Soon)​

  • Simple Blog with Payments
  • E-commerce Store
  • SaaS Application

Community​

🤝 Need Help?​

✅ Next Steps Checklist​

After completing this guide, you should:

  • Have SophiChain running locally
  • Understand the module structure
  • Know where to find documentation
  • Be ready to integrate or extend

Ready to dive deeper? Choose your path:

Last Updated: October 7, 2025
Guide Version: 1.0