SUDIGITAL

Appearance

SUDIGITAL Platform ​

Welcome to the SUDIGITAL Digital Innovation Platform documentation.

Overview ​

SUDIGITAL is a modern, scalable digital platform built with cutting-edge technologies and best practices. This platform serves as the foundation for digital innovation projects.

Architecture ​

The platform is built as a monorepo with the following packages:

  • @sudigital/core - Shared utilities, types, and design tokens
  • @sudigital/api - Backend services and REST APIs with OpenAPI documentation
  • @sudigital/web - Frontend web application
  • @sudigital/docs - Documentation site

Quick Start ​

bash
# Clone the repository
git clone https://github.com/sudigital/platform.git

# Install dependencies
bun install

# Start development environment
bun run dev

API Documentation ​

The platform includes comprehensive API documentation powered by Scalar API Reference.

Available Endpoints ​

API Features ​

🔥 Scalar API Reference Integration ​

  • Beautiful, interactive API documentation
  • Purple theme for SUDIGITAL branding
  • Real-time API testing capabilities
  • Comprehensive endpoint documentation

📋 OpenAPI 3.1 Specification ​

  • Complete API schema documentation
  • Request/response examples
  • Parameter validation
  • Error response documentation

🤖 LLM-friendly Documentation ​

  • Markdown export at /llms.txt
  • Follows llmstxt.org standards
  • Optimized for AI/LLM consumption

🛠 Built with Modern Stack ​

  • Hono - Fast, lightweight web framework
  • Zod OpenAPI - Type-safe API validation
  • TypeORM - Database ORM with Azure PostgreSQL
  • UUID Support - Native PostgreSQL 13+ UUID generation

API Endpoints ​

Health Endpoints ​

  • GET /api/health - API health check

User Management ​

  • GET /api/users - List all users
  • GET /api/users/{id} - Get user by ID
  • POST /api/users - Create new user

Development Features ​

  • Hot Reload - Automatic server restart on changes
  • Type Safety - Full TypeScript support
  • Database Integration - Azure PostgreSQL with UUID support
  • CORS Support - Cross-origin resource sharing
  • Request Logging - Development-friendly logging
  • Pretty JSON - Formatted JSON responses

Configuration ​

The API uses centralized configuration from @sudigital/core:

typescript
import { api, database } from '@sudigital/core'

// API configuration
console.log(api.port) // 3001
console.log(api.environment) // development

// Database configuration
console.log(database.host) // Azure PostgreSQL host
console.log(database.ssl) // SSL configuration

Features ​

  • 🚀 Fast Development - Built with Bun for lightning-fast package management
  • 📦 Monorepo Structure - Organized workspace with shared packages
  • 🎨 Design System - Consistent design tokens and components
  • 🔧 TypeScript - Full type safety across all packages
  • 🧪 Testing - Comprehensive test coverage with Vitest
  • 📚 Documentation - Auto-generated docs with VitePress

Getting Started ​

Continue to the Quick Start Guide to begin development.