Documentation

    Documentation

    Documentation

    Ring Platform Logo

    Завантаження документації...

    Підготовка контенту платформи Ring

    Ring Platform Logo

    Завантаження документації...

    Підготовка контенту платформи Ring

    Ring Platform Logo

    Завантаження документації...

    Підготовка контенту платформи Ring

    1. /
    2. /Code Structure

    2 мин прослушивания

    1. /
    2. /Code Structure

    2 мин прослушивания

    1. /
    2. /Code Structure

    2 мин прослушивания

    navigation.docs_sidebar.audience.founderHint

    Добро пожаловать в Ring Platform
    Краткий справочник
    С чего начать
    Предварительные требования
    Установка
    Первый успех
    Следующие шаги
    Архитектура
    Data Model
    Real Time
    Security
    Бекенд Сервисы
    Режим k8s-postgres-fcm
    Интеграция Firebase
    Функции
    Authentication
    Email AI-CRM
    Entities
    Opportunities
    Messaging
    Notifications
    Push-уведомления через FCM (Ring)
    Протокол Tunnel
    Web3 Кошелек
    Store
    Реферальные коды (Refcodes)
    Интеграция платежей
    PaymentConductor
    SubscriptionConductor
    Модуль Новостей - Цифровой Газетный Опыт
    Блоги участников
    Система Резервирования Имён Пользователей
    Научный редактор
    Система локалей
    Безопасность и соответствие
    NFT Маркетплейс
    Система Стейкинга Токенов
    Паттерны Оптимизации Производительности
    Мобильный Опыт
    API-интерфейс
    Аутентификация
    Email AI-CRM API
    Сущности
    Opportunities
    Messaging
    Notifications
    Wallet
    Store
    Администрирование
    Кастомизация
    Настройка токеномики
    Branding
    Themes
    Web3
    Token launch jurisdictions
    Развёртывание
    Self-hosted развёртывание
    Vercel
    Docker
    Monitoring
    Оптимизация производительности
    Backup
    Разработка
    Локальная настройка
    Code Structure
    Компоненты документации
    Community tooling
    Ring MCP Server
    Генеративные изображения (ImageConductor)
    Автономная редакция (Grok)
    OSS vs enterprise
    Лучшие практики
    Workflow
    Code Style
    Производительность
    Testing
    Развёртывание
    Debugging
    Contributing
    Примеры
    Quick Start
    White Label
    Реальные Проекты
    Интеграции
    Ethereum-кошельки (Wagmi v3)

    Быстрый вход (CTO · аудиторы · агенты)

    Приветствие — миссия и аудитории
    Краткий справочник
    С чего начать
    Архитектура и Auth.js
    Режимы бэкенда и БД (DB_BACKEND_MODE)
    Self-hosted
    Ring MCP Tools
    Ring MCP Server
    Token economics
    Token launch jurisdictions
    Деплой (Docker · k8s)
    Безопасность и комплаенс
    ringdom.org — база LegioX
    Исходники — лицензия MIT (GitHub)

    navigation.docs_sidebar.audience.founderHint

    Добро пожаловать в Ring Platform
    Краткий справочник
    С чего начать
    Предварительные требования
    Установка
    Первый успех
    Следующие шаги
    Архитектура
    Data Model
    Real Time
    Security
    Бекенд Сервисы
    Режим k8s-postgres-fcm
    Интеграция Firebase
    Функции
    Authentication
    Email AI-CRM
    Entities
    Opportunities
    Messaging
    Notifications
    Push-уведомления через FCM (Ring)
    Протокол Tunnel
    Web3 Кошелек
    Store
    Реферальные коды (Refcodes)
    Интеграция платежей
    PaymentConductor
    SubscriptionConductor
    Модуль Новостей - Цифровой Газетный Опыт
    Блоги участников
    Система Резервирования Имён Пользователей
    Научный редактор
    Система локалей
    Безопасность и соответствие
    NFT Маркетплейс
    Система Стейкинга Токенов
    Паттерны Оптимизации Производительности
    Мобильный Опыт
    API-интерфейс
    Аутентификация
    Email AI-CRM API
    Сущности
    Opportunities
    Messaging
    Notifications
    Wallet
    Store
    Администрирование
    Кастомизация
    Настройка токеномики
    Branding
    Themes
    Web3
    Token launch jurisdictions
    Развёртывание
    Self-hosted развёртывание
    Vercel
    Docker
    Monitoring
    Оптимизация производительности
    Backup
    Разработка
    Локальная настройка
    Code Structure
    Компоненты документации
    Community tooling
    Ring MCP Server
    Генеративные изображения (ImageConductor)
    Автономная редакция (Grok)
    OSS vs enterprise
    Лучшие практики
    Workflow
    Code Style
    Производительность
    Testing
    Развёртывание
    Debugging
    Contributing
    Примеры
    Quick Start
    White Label
    Реальные Проекты
    Интеграции
    Ethereum-кошельки (Wagmi v3)

    Быстрый вход (CTO · аудиторы · агенты)

    Приветствие — миссия и аудитории
    Краткий справочник
    С чего начать
    Архитектура и Auth.js
    Режимы бэкенда и БД (DB_BACKEND_MODE)
    Self-hosted
    Ring MCP Tools
    Ring MCP Server
    Token economics
    Token launch jurisdictions
    Деплой (Docker · k8s)
    Безопасность и комплаенс
    ringdom.org — база LegioX
    Исходники — лицензия MIT (GitHub)

    navigation.docs_sidebar.audience.founderHint

    Добро пожаловать в Ring Platform
    Краткий справочник
    С чего начать
    Предварительные требования
    Установка
    Первый успех
    Следующие шаги
    Архитектура
    Data Model
    Real Time
    Security
    Бекенд Сервисы
    Режим k8s-postgres-fcm
    Интеграция Firebase
    Функции
    Authentication
    Email AI-CRM
    Entities
    Opportunities
    Messaging
    Notifications
    Push-уведомления через FCM (Ring)
    Протокол Tunnel
    Web3 Кошелек
    Store
    Реферальные коды (Refcodes)
    Интеграция платежей
    PaymentConductor
    SubscriptionConductor
    Модуль Новостей - Цифровой Газетный Опыт
    Блоги участников
    Система Резервирования Имён Пользователей
    Научный редактор
    Система локалей
    Безопасность и соответствие
    NFT Маркетплейс
    Система Стейкинга Токенов
    Паттерны Оптимизации Производительности
    Мобильный Опыт
    API-интерфейс
    Аутентификация
    Email AI-CRM API
    Сущности
    Opportunities
    Messaging
    Notifications
    Wallet
    Store
    Администрирование
    Кастомизация
    Настройка токеномики
    Branding
    Themes
    Web3
    Token launch jurisdictions
    Развёртывание
    Self-hosted развёртывание
    Vercel
    Docker
    Monitoring
    Оптимизация производительности
    Backup
    Разработка
    Локальная настройка
    Code Structure
    Компоненты документации
    Community tooling
    Ring MCP Server
    Генеративные изображения (ImageConductor)
    Автономная редакция (Grok)
    OSS vs enterprise
    Лучшие практики
    Workflow
    Code Style
    Производительность
    Testing
    Развёртывание
    Debugging
    Contributing
    Примеры
    Quick Start
    White Label
    Реальные Проекты
    Интеграции
    Ethereum-кошельки (Wagmi v3)

    Быстрый вход (CTO · аудиторы · агенты)

    Приветствие — миссия и аудитории
    Краткий справочник
    С чего начать
    Архитектура и Auth.js
    Режимы бэкенда и БД (DB_BACKEND_MODE)
    Self-hosted
    Ring MCP Tools
    Ring MCP Server
    Token economics
    Token launch jurisdictions
    Деплой (Docker · k8s)
    Безопасность и комплаенс
    ringdom.org — база LegioX
    Исходники — лицензия MIT (GitHub)
    Документация
    Разработка
    Документация
    Разработка
    Документация
    Разработка

    Структура кода

    Понимание кодовой базы Ring Platform v1.6.0.

    📁 Высокоуровневая архитектура

    text
    
    ring/
    ├── app/                    # Next.js 16 App Router
    ├── components/             # UI, editor, navigation
    ├── features/               # news, store, auth, …
    ├── lib/                    # locale-config, payments/conductor, database
    ├── locales/                # next-intl JSON (en, uk, ru)
    ├── data/                   # schema.sql + migrations/
    └── scripts/                # Community OSS scripts

    Не в публичном OSS: k8s/, cli/, propagation/ (gitignored).

    Ключевые модули v1.6.0

    ОбластьПуть
    PaymentConductorlib/payments/conductor/
    News Kingdomfeatures/news/services/, lib/news/
    Locale SSOTlib/locale-config.ts

    🏗️ App Directory Structure

    App Router (Next.js 16)

    text
    
    app/
    ├── (auth)/            # Route groups for auth pages
    │   ├── login/
    │   └── register/
    ├── (dashboard)/       # Protected dashboard routes
    │   ├── entities/
    │   ├── opportunities/
    │   └── wallet/
    ├── api/              # API routes
    │   ├── auth/
    │   ├── entities/
    │   └── opportunities/
    ├── globals.css       # Global styles
    ├── layout.tsx        # Root layout
    └── page.tsx          # Homepage

    Route Groups

    • (auth) - Authentication-related pages
    • (dashboard) - Protected user dashboard
    • (public) - Public marketing pages

    🧩 Components Architecture

    Component Hierarchy

    text
    
    components/
    ├── ui/               # Base UI components (shadcn/ui)
    │   ├── button.tsx
    │   ├── input.tsx
    │   └── dialog.tsx
    ├── features/         # Feature-specific components
    │   ├── entities/
    │   ├── opportunities/
    │   └── wallet/
    ├── layout/          # Layout components
    │   ├── navbar.tsx
    │   ├── sidebar.tsx
    │   └── footer.tsx
    └── shared/          # Shared business components
        ├── user-avatar.tsx
        └── loading-spinner.tsx

    Component Patterns

    1. Base UI Components

    // components/ui/button.tsx

    2. Feature Components

    // components/features/entities/entity-card.tsx

    🎯 Features Architecture

    Feature-Based Organization

    Feature Module Pattern

    // features/entities/index.ts - Public API

    Custom Hooks Pattern

    // features/entities/hooks/use-entities.ts

    🔧 Lib Directory

    Shared Utilities

    Key Utilities

    Authentication Configuration

    // lib/auth.ts

    Database Utilities

    // lib/db.ts

    ⚡ Server Actions

    Server Actions Structure

    Server Action Pattern

    📝 TypeScript Patterns

    Type Organization

    // types/entities.ts

    API Response Types

    // types/api.ts

    🎨 Styling Architecture

    Tailwind CSS Organization

    Component Styling Patterns

    // Using cn utility for conditional classes

    📚 Best Practices

    1. Import Organization

    // External imports first

    2. Component File Structure

    // 1. Imports

    3. Feature Boundaries

    • Keep feature code within feature directories
    • Use public APIs for cross-feature communication
    • Avoid deep imports from other features

    Next: Development Workflow - Learn about our Git workflow and development process.

    Структура кода

    Понимание кодовой базы Ring Platform v1.6.0.

    📁 Высокоуровневая архитектура

    text
    
    ring/
    ├── app/                    # Next.js 16 App Router
    ├── components/             # UI, editor, navigation
    ├── features/               # news, store, auth, …
    ├── lib/                    # locale-config, payments/conductor, database
    ├── locales/                # next-intl JSON (en, uk, ru)
    ├── data/                   # schema.sql + migrations/
    └── scripts/                # Community OSS scripts

    Не в публичном OSS: k8s/, cli/, propagation/ (gitignored).

    Ключевые модули v1.6.0

    ОбластьПуть
    PaymentConductorlib/payments/conductor/
    News Kingdomfeatures/news/services/, lib/news/
    Locale SSOTlib/locale-config.ts

    🏗️ App Directory Structure

    App Router (Next.js 16)

    text
    
    app/
    ├── (auth)/            # Route groups for auth pages
    │   ├── login/
    │   └── register/
    ├── (dashboard)/       # Protected dashboard routes
    │   ├── entities/
    │   ├── opportunities/
    │   └── wallet/
    ├── api/              # API routes
    │   ├── auth/
    │   ├── entities/
    │   └── opportunities/
    ├── globals.css       # Global styles
    ├── layout.tsx        # Root layout
    └── page.tsx          # Homepage

    Route Groups

    • (auth) - Authentication-related pages
    • (dashboard) - Protected user dashboard
    • (public) - Public marketing pages

    🧩 Components Architecture

    Component Hierarchy

    text
    
    components/
    ├── ui/               # Base UI components (shadcn/ui)
    │   ├── button.tsx
    │   ├── input.tsx
    │   └── dialog.tsx
    ├── features/         # Feature-specific components
    │   ├── entities/
    │   ├── opportunities/
    │   └── wallet/
    ├── layout/          # Layout components
    │   ├── navbar.tsx
    │   ├── sidebar.tsx
    │   └── footer.tsx
    └── shared/          # Shared business components
        ├── user-avatar.tsx
        └── loading-spinner.tsx

    Component Patterns

    1. Base UI Components

    // components/ui/button.tsx

    2. Feature Components

    // components/features/entities/entity-card.tsx

    🎯 Features Architecture

    Feature-Based Organization

    Feature Module Pattern

    // features/entities/index.ts - Public API

    Custom Hooks Pattern

    // features/entities/hooks/use-entities.ts

    🔧 Lib Directory

    Shared Utilities

    Key Utilities

    Authentication Configuration

    // lib/auth.ts

    Database Utilities

    // lib/db.ts

    ⚡ Server Actions

    Server Actions Structure

    Server Action Pattern

    📝 TypeScript Patterns

    Type Organization

    // types/entities.ts

    API Response Types

    // types/api.ts

    🎨 Styling Architecture

    Tailwind CSS Organization

    Component Styling Patterns

    // Using cn utility for conditional classes

    📚 Best Practices

    1. Import Organization

    // External imports first

    2. Component File Structure

    // 1. Imports

    3. Feature Boundaries

    • Keep feature code within feature directories
    • Use public APIs for cross-feature communication
    • Avoid deep imports from other features

    Next: Development Workflow - Learn about our Git workflow and development process.

    Структура кода

    Понимание кодовой базы Ring Platform v1.6.0.

    📁 Высокоуровневая архитектура

    text
    
    ring/
    ├── app/                    # Next.js 16 App Router
    ├── components/             # UI, editor, navigation
    ├── features/               # news, store, auth, …
    ├── lib/                    # locale-config, payments/conductor, database
    ├── locales/                # next-intl JSON (en, uk, ru)
    ├── data/                   # schema.sql + migrations/
    └── scripts/                # Community OSS scripts

    Не в публичном OSS: k8s/, cli/, propagation/ (gitignored).

    Ключевые модули v1.6.0

    ОбластьПуть
    PaymentConductorlib/payments/conductor/
    News Kingdomfeatures/news/services/, lib/news/
    Locale SSOTlib/locale-config.ts

    🏗️ App Directory Structure

    App Router (Next.js 16)

    text
    
    app/
    ├── (auth)/            # Route groups for auth pages
    │   ├── login/
    │   └── register/
    ├── (dashboard)/       # Protected dashboard routes
    │   ├── entities/
    │   ├── opportunities/
    │   └── wallet/
    ├── api/              # API routes
    │   ├── auth/
    │   ├── entities/
    │   └── opportunities/
    ├── globals.css       # Global styles
    ├── layout.tsx        # Root layout
    └── page.tsx          # Homepage

    Route Groups

    • (auth) - Authentication-related pages
    • (dashboard) - Protected user dashboard
    • (public) - Public marketing pages

    🧩 Components Architecture

    Component Hierarchy

    text
    
    components/
    ├── ui/               # Base UI components (shadcn/ui)
    │   ├── button.tsx
    │   ├── input.tsx
    │   └── dialog.tsx
    ├── features/         # Feature-specific components
    │   ├── entities/
    │   ├── opportunities/
    │   └── wallet/
    ├── layout/          # Layout components
    │   ├── navbar.tsx
    │   ├── sidebar.tsx
    │   └── footer.tsx
    └── shared/          # Shared business components
        ├── user-avatar.tsx
        └── loading-spinner.tsx

    Component Patterns

    1. Base UI Components

    // components/ui/button.tsx

    2. Feature Components

    // components/features/entities/entity-card.tsx

    🎯 Features Architecture

    Feature-Based Organization

    Feature Module Pattern

    // features/entities/index.ts - Public API

    Custom Hooks Pattern

    // features/entities/hooks/use-entities.ts

    🔧 Lib Directory

    Shared Utilities

    Key Utilities

    Authentication Configuration

    // lib/auth.ts

    Database Utilities

    // lib/db.ts

    ⚡ Server Actions

    Server Actions Structure

    Server Action Pattern

    📝 TypeScript Patterns

    Type Organization

    // types/entities.ts

    API Response Types

    // types/api.ts

    🎨 Styling Architecture

    Tailwind CSS Organization

    Component Styling Patterns

    // Using cn utility for conditional classes

    📚 Best Practices

    1. Import Organization

    // External imports first

    2. Component File Structure

    // 1. Imports

    3. Feature Boundaries

    • Keep feature code within feature directories
    • Use public APIs for cross-feature communication
    • Avoid deep imports from other features

    Next: Development Workflow - Learn about our Git workflow and development process.

    text
    
    features/
    ├── entities/         # Entity management feature
    │   ├── components/   # Feature-specific components
    │   ├── hooks/       # Custom hooks
    │   ├── types/       # TypeScript types
    │   ├── utils/       # Feature utilities
    │   └── index.ts     # Public API
    ├── opportunities/   # Opportunities feature
    ├── wallet/         # Web3 wallet feature
    └── messaging/      # Real-time messaging
    text
    
    lib/
    ├── auth.ts          # Auth.js configuration
    ├── firebase.ts      # Firebase setup
    ├── db.ts           # Database utilities
    ├── utils.ts        # General utilities
    ├── validations.ts  # Zod schemas
    ├── constants.ts    # App constants
    └── types.ts        # Global types
    text
    
    @actions/
    ├── entities/
    │   ├── create-entity.ts
    │   ├── update-entity.ts
    │   └── delete-entity.ts
    ├── opportunities/
    └── auth/
    text
    
    app/globals.css
    ├── @tailwind base;
    ├── @tailwind components;
    ├── @tailwind utilities;
    └── /* Custom component styles */
    text
    
    features/
    ├── entities/         # Entity management feature
    │   ├── components/   # Feature-specific components
    │   ├── hooks/       # Custom hooks
    │   ├── types/       # TypeScript types
    │   ├── utils/       # Feature utilities
    │   └── index.ts     # Public API
    ├── opportunities/   # Opportunities feature
    ├── wallet/         # Web3 wallet feature
    └── messaging/      # Real-time messaging
    text
    
    lib/
    ├── auth.ts          # Auth.js configuration
    ├── firebase.ts      # Firebase setup
    ├── db.ts           # Database utilities
    ├── utils.ts        # General utilities
    ├── validations.ts  # Zod schemas
    ├── constants.ts    # App constants
    └── types.ts        # Global types
    text
    
    @actions/
    ├── entities/
    │   ├── create-entity.ts
    │   ├── update-entity.ts
    │   └── delete-entity.ts
    ├── opportunities/
    └── auth/
    text
    
    app/globals.css
    ├── @tailwind base;
    ├── @tailwind components;
    ├── @tailwind utilities;
    └── /* Custom component styles */
    text
    
    features/
    ├── entities/         # Entity management feature
    │   ├── components/   # Feature-specific components
    │   ├── hooks/       # Custom hooks
    │   ├── types/       # TypeScript types
    │   ├── utils/       # Feature utilities
    │   └── index.ts     # Public API
    ├── opportunities/   # Opportunities feature
    ├── wallet/         # Web3 wallet feature
    └── messaging/      # Real-time messaging
    text
    
    lib/
    ├── auth.ts          # Auth.js configuration
    ├── firebase.ts      # Firebase setup
    ├── db.ts           # Database utilities
    ├── utils.ts        # General utilities
    ├── validations.ts  # Zod schemas
    ├── constants.ts    # App constants
    └── types.ts        # Global types
    text
    
    @actions/
    ├── entities/
    │   ├── create-entity.ts
    │   ├── update-entity.ts
    │   └── delete-entity.ts
    ├── opportunities/
    └── auth/
    text
    
    app/globals.css
    ├── @tailwind base;
    ├── @tailwind components;
    ├── @tailwind utilities;
    └── /* Custom component styles */