Advanced Search
Search Results
83 total results found
Introduction
What is the Hypermodern Platform? The Hypermodern platform is a unified communication framework built in Dart that revolutionizes how we think about client-server architecture. Unlike traditional approaches where you might choose between HTTP REST APIs, WebSoc...
Getting Started
Installation and Setup Prerequisites Before diving into Hypermodern development, ensure you have: Dart SDK 3.0.0 or later: Download from dart.dev A code editor: VS Code with the Dart extension is recommended Basic Dart knowledge: Familiarity with Dart syntax ...
Core Concepts
Transport Protocols Deep Dive Understanding how Hypermodern handles multiple transport protocols is crucial to leveraging its full potential. Each protocol serves different use cases while maintaining API consistency. HTTP/HTTPS Transport HTTP transport provid...
Schema-Driven Development
The Power of Schema-First Design Schema-driven development puts your API contract at the center of your development process. Instead of writing code first and documenting later, you define your API structure upfront and generate everything else from that singl...
Client Development
Setting Up the Hypermodern Client The Hypermodern client provides a unified interface for communicating with servers across multiple protocols. Whether you're building a mobile app, web application, or desktop client, the API remains consistent. Basic Client S...
Server Development
Creating Hypermodern Servers Building a Hypermodern server means creating an application that can simultaneously handle HTTP, WebSocket, and TCP connections while sharing the same business logic across all protocols. Basic Server Setup import 'package:hypermod...
Multi-Protocol Communication
Understanding Protocol Selection One of Hypermodern's most powerful features is its ability to serve the same API across multiple protocols. Understanding when and how to use each protocol optimally is key to building high-performance applications. Protocol Ch...
Module System
Understanding Hypermodern Modules The Hypermodern module system enables you to create reusable, self-contained components that encapsulate related functionality, schemas, and services. Modules promote code reuse, maintainability, and team collaboration by allo...
ORM and Data Management
Built-in ORM Features Hypermodern includes a powerful Object-Relational Mapping (ORM) system that seamlessly integrates with the schema-driven development approach. The ORM automatically generates database schemas from your JSON models and provides type-safe d...
Authentication and Security
JWT Implementation JSON Web Tokens (JWT) provide a stateless authentication mechanism that works seamlessly across all Hypermodern transport protocols. The platform includes built-in JWT support with automatic token validation and refresh capabilities. JWT Ser...
Performance and Optimization
Binary Serialization Benefits One of Hypermodern's key performance advantages is its use of binary serialization by default. This provides significant improvements over JSON in terms of both speed and bandwidth usage. Performance Comparison class Serialization...
Development Workflow
Using the Hypermodern CLI The Hypermodern CLI is your primary development tool, providing project scaffolding, code generation, development servers, and deployment utilities. Mastering the CLI significantly improves your development velocity. CLI Command Refer...
Production Deployment
Building for Production Preparing a Hypermodern application for production involves optimization, security hardening, and creating deployable artifacts that can run efficiently in production environments. Production Build Process # Basic production build hyper...
Real-World Examples
AI-Powered Document Search Application This example demonstrates building a modern document search application using UUID v7 for time-ordered identifiers and vector embeddings for semantic search capabilities. Application Overview Our document search applicati...
Module Ecosystem and Extensions
Popular Community Modules The Hypermodern ecosystem includes a rich collection of community-contributed modules that extend the platform's capabilities. These modules provide pre-built solutions for common use cases and integrate seamlessly with the core platf...
Integration Patterns
Database Integrations Hypermodern's flexible architecture allows seamless integration with various database systems, from traditional SQL databases to modern NoSQL solutions and specialized data stores. Multi-Database Architecture class MultiDatabaseManager { ...
Appendix A: API Reference
Core Classes HypermodernServer The main server class that handles multi-protocol communication. class HypermodernServer { // Constructor HypermodernServer({ ServerConfig? config, ModuleContainer? container, }); // Configuration void config...
Appendix B: CLI Command Reference
Installation # Install globally dart pub global activate hypermodern_cli # Verify installation hypermodern --version Global Options All commands support these global options: --help, -h: Show help information --verbose, -v: Enable verbose output --quiet, -q...
Appendix C: Schema Format Specification
Overview Hypermodern uses JSON schemas to define API contracts, data models, and service interfaces. This specification defines the complete schema format and validation rules. Schema Structure A Hypermodern schema file has the following top-level structure: {...
Appendix D: Migration Guides
Migrating from REST APIs From Express.js If you're coming from Express.js, here's how to migrate your existing REST API to Hypermodern. Before (Express.js) const express = require('express'); const app = express(); app.use(express.json()); // User routes app...