Guide

Introduction

Welcome to the SUDIGITAL platform guide! This comprehensive guide will walk you through everything you need to know to get started with the platform.

What is SUDIGITAL?

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

• Scalable Architecture - Monorepo structure with independent packages
• Modern Stack - Built with Bun, TypeScript, Hono, and React
• API-First Design - RESTful APIs with OpenAPI documentation
• Database Integration - Azure PostgreSQL with UUID support
• Interactive Documentation - Scalar API Reference integration

Platform Components

Core Packages

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

Key Features

• Type Safety - Full TypeScript support across all packages
• Hot Reload - Fast development with instant updates
• API Documentation - Interactive docs with Scalar API Reference
• Database ORM - TypeORM with Azure PostgreSQL
• Modern Tooling - Bun for package management and runtime

Getting Started

Ready to start building? Check out our guides:

• Quick Start - Get up and running in minutes
• Installation - Detailed installation instructions
• API Overview - Explore the API capabilities
• Design System - Learn about our design tokens and components

Architecture Overview

The platform follows a monorepo architecture with the following structure:

packages/
├── core/          # Shared utilities and design tokens
├── api/           # Backend services and APIs
├── web/           # Frontend React application
└── docs/          # Documentation site

Technology Stack

• Runtime: Bun (fast package manager and runtime)
• Language: TypeScript (strict type checking)
• API Framework: Hono (lightweight and fast)
• Database: Azure PostgreSQL with TypeORM
• Frontend: React 18 with Vite
• Documentation: VitePress with Scalar API Reference

Development Workflow

1. Setup - Clone repository and install dependencies
2. Development - Run all services with bun run dev
3. Testing - Comprehensive test suites with Vitest
4. Building - Production builds with optimization
5. Deployment - Ready for cloud deployment

Next Steps

• Follow the Quick Start guide
• Explore the API documentation
• Learn about the Design System
• Check out the Scalar Integration