SUDIGITAL

Appearance

Quick Start ​

Get up and running with SUDIGITAL in just a few minutes!

Prerequisites ​

Before you begin, ensure you have the following installed:

Step 1: Clone the Repository ​

bash
git clone https://github.com/sudigital/platform.git
cd platform

Step 2: Install Dependencies ​

Using Bun for fast installation:

bash
bun install

Step 3: Environment Configuration ​

Copy the environment template and configure your settings:

bash
cp .env.example .env

Edit the .env file with your configuration:

properties
# Database Configuration
DB_HOST=sudigitalpostgresqldev.postgres.database.azure.com
DB_PORT=5432
DB_USERNAME=your-username
DB_PASSWORD=your-password
DB_NAME=postgres

# API Configuration
API_PORT=3001
API_CORS_ORIGINS=http://localhost:3000

# Web Configuration
WEB_PORT=3000

# Documentation
DOCS_PORT=5173

Step 4: Start Development ​

Start all services in development mode:

bash
bun run dev

This command will start:

Step 5: Verify Installation ​

Check API Health ​

bash
curl http://localhost:3001/api/health

Expected response:

json
{
  "status": "healthy",
  "timestamp": "2025-08-17T10:30:00.000Z",
  "version": "0.1.0"
}

Access Interactive Documentation ​

Visit http://localhost:3001/docs to explore the API documentation powered by Scalar.

Check Web Application ​

Visit http://localhost:3000 to see the frontend application.

Step 6: Explore the Platform ​

API Documentation ​

Available Endpoints ​

  • GET / - API information
  • GET /api/health - Health check
  • GET /api/users - User management
  • POST /api/users - Create new user

Development Commands ​

Individual Package Development ​

bash
# Start only API server
bun run --filter='@sudigital/api' dev

# Start only web application
bun run --filter='@sudigital/web' dev

# Start only documentation
bun run --filter='@sudigital/docs' dev

Building for Production ​

bash
# Build all packages
bun run build

# Build specific package
bun run --filter='@sudigital/api' build

Testing ​

bash
# Run all tests
bun test

# Run tests in watch mode
bun test:watch

# Type checking
bun typecheck

Troubleshooting ​

Port Already in Use ​

bash
# Kill processes on ports
lsof -ti:3001 | xargs kill -9  # API
lsof -ti:3000 | xargs kill -9  # Web
lsof -ti:5173 | xargs kill -9  # Docs

Database Connection Issues ​

  1. Verify your .env configuration
  2. Check Azure PostgreSQL firewall settings
  3. Ensure SSL connection is properly configured

Module Resolution Errors ​

bash
# Clean and reinstall dependencies
rm -rf node_modules packages/*/node_modules
bun install

Next Steps ​

Now that you have the platform running:

  1. Explore the API - Check out the API documentation
  2. Learn the Architecture - Read the guide
  3. Design System - Explore design tokens
  4. Scalar Integration - Learn about API documentation

Need Help? ​

Happy coding! 🚀