Documentation

    Documentation

    Documentation

    Ring Platform Logo

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

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

    Ring Platform Logo

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

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

    Ring Platform Logo

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

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

    1. /
    2. /Структура коду

    2 хв прослуховування

    1. /
    2. /Структура коду

    2 хв прослуховування

    1. /
    2. /Структура коду

    2 хв прослуховування

    Концепції, цінність і типові сценарії

    Ласкаво просимо до Ring
    Швидкий довідник
    Початок роботи
    Передумови
    Встановлення
    Валідація першого успіху
    Наступні кроки
    Архітектура
    Data Model
    Real Time
    Security
    Бекенд Сервіси
    Режим k8s-postgres-fcm
    Інтеграція Firebase
    Функції
    Authentication
    Email AI-CRM
    Сутності
    Можливості
    Повідомлення
    Notifications
    Push-сповіщення через FCM (Ring)
    Протокол Tunnel
    Web3 Гаманець
    Магазин
    Реферальні коди (Refcodes)
    Інтеграція платежів
    PaymentConductor
    SubscriptionConductor
    Модуль Новин - Цифровий Газетний Досвід
    Блоги учасників
    Система Резервування Імен Користувачів
    Науковий редактор
    Система локалей
    Безпека та відповідність
    NFT Маркетплейс
    Система Стейкінга Токенів
    Паттерни Оптимізації Продуктивності
    Мобільний Досвід
    API-інтерфейс
    Аутентифікація
    Email AI-CRM API
    Entities
    Можливості
    API повідомлень
    API повідомлень
    Гаманець
    API магазину
    API адміністратора
    Кастомізація
    Швидкий старт — ваш перший клон Ring
    Повний посібник налаштування
    Налаштування токеноміки
    Інтеграція платіжних шлюзів
    Еталонні деплої Ring
    Брендування
    Теми
    Web3
    Token launch jurisdictions
    Розгортання
    Self-hosted розгортання
    Vercel
    Docker
    Моніторинг та аналітика
    Оптимізація продуктивності
    Резервне копіювання та відновлення
    Розробка
    Локальне налаштування
    Структура коду
    Компоненти документації
    Community tooling
    Ring MCP Server
    Генеративні зображення (ImageConductor)
    Автономна редакція (Grok)
    OSS vs enterprise
    Найкращі практики
    Workflow
    Code Style
    Продуктивність
    Тестування
    Розгортання
    Налагодження
    Співпраця
    Приклади
    Швидкий старт
    Білий лейбл
    Реальні приклади
    Інтеграції
    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
    Швидкий довідник
    Початок роботи
    Передумови
    Встановлення
    Валідація першого успіху
    Наступні кроки
    Архітектура
    Data Model
    Real Time
    Security
    Бекенд Сервіси
    Режим k8s-postgres-fcm
    Інтеграція Firebase
    Функції
    Authentication
    Email AI-CRM
    Сутності
    Можливості
    Повідомлення
    Notifications
    Push-сповіщення через FCM (Ring)
    Протокол Tunnel
    Web3 Гаманець
    Магазин
    Реферальні коди (Refcodes)
    Інтеграція платежів
    PaymentConductor
    SubscriptionConductor
    Модуль Новин - Цифровий Газетний Досвід
    Блоги учасників
    Система Резервування Імен Користувачів
    Науковий редактор
    Система локалей
    Безпека та відповідність
    NFT Маркетплейс
    Система Стейкінга Токенів
    Паттерни Оптимізації Продуктивності
    Мобільний Досвід
    API-інтерфейс
    Аутентифікація
    Email AI-CRM API
    Entities
    Можливості
    API повідомлень
    API повідомлень
    Гаманець
    API магазину
    API адміністратора
    Кастомізація
    Швидкий старт — ваш перший клон Ring
    Повний посібник налаштування
    Налаштування токеноміки
    Інтеграція платіжних шлюзів
    Еталонні деплої Ring
    Брендування
    Теми
    Web3
    Token launch jurisdictions
    Розгортання
    Self-hosted розгортання
    Vercel
    Docker
    Моніторинг та аналітика
    Оптимізація продуктивності
    Резервне копіювання та відновлення
    Розробка
    Локальне налаштування
    Структура коду
    Компоненти документації
    Community tooling
    Ring MCP Server
    Генеративні зображення (ImageConductor)
    Автономна редакція (Grok)
    OSS vs enterprise
    Найкращі практики
    Workflow
    Code Style
    Продуктивність
    Тестування
    Розгортання
    Налагодження
    Співпраця
    Приклади
    Швидкий старт
    Білий лейбл
    Реальні приклади
    Інтеграції
    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
    Швидкий довідник
    Початок роботи
    Передумови
    Встановлення
    Валідація першого успіху
    Наступні кроки
    Архітектура
    Data Model
    Real Time
    Security
    Бекенд Сервіси
    Режим k8s-postgres-fcm
    Інтеграція Firebase
    Функції
    Authentication
    Email AI-CRM
    Сутності
    Можливості
    Повідомлення
    Notifications
    Push-сповіщення через FCM (Ring)
    Протокол Tunnel
    Web3 Гаманець
    Магазин
    Реферальні коди (Refcodes)
    Інтеграція платежів
    PaymentConductor
    SubscriptionConductor
    Модуль Новин - Цифровий Газетний Досвід
    Блоги учасників
    Система Резервування Імен Користувачів
    Науковий редактор
    Система локалей
    Безпека та відповідність
    NFT Маркетплейс
    Система Стейкінга Токенів
    Паттерни Оптимізації Продуктивності
    Мобільний Досвід
    API-інтерфейс
    Аутентифікація
    Email AI-CRM API
    Entities
    Можливості
    API повідомлень
    API повідомлень
    Гаманець
    API магазину
    API адміністратора
    Кастомізація
    Швидкий старт — ваш перший клон Ring
    Повний посібник налаштування
    Налаштування токеноміки
    Інтеграція платіжних шлюзів
    Еталонні деплої Ring
    Брендування
    Теми
    Web3
    Token launch jurisdictions
    Розгортання
    Self-hosted розгортання
    Vercel
    Docker
    Моніторинг та аналітика
    Оптимізація продуктивності
    Резервне копіювання та відновлення
    Розробка
    Локальне налаштування
    Структура коду
    Компоненти документації
    Community tooling
    Ring MCP Server
    Генеративні зображення (ImageConductor)
    Автономна редакція (Grok)
    OSS vs enterprise
    Найкращі практики
    Workflow
    Code Style
    Продуктивність
    Тестування
    Розгортання
    Налагодження
    Співпраця
    Приклади
    Швидкий старт
    Білий лейбл
    Реальні приклади
    Інтеграції
    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

    App Router (Next.js 16)

    text
    
    app/
    ├── (auth)/            # Групи маршрутів для сторінок автентифікації
    │   ├── login/
    │   └── register/
    ├── (dashboard)/       # Захищені маршрути панелі керування
    │   ├── entities/
    │   ├── opportunities/
    │   └── wallet/
    ├── api/               # API маршрути
    │   ├── auth/
    │   ├── entities/
    │   └── opportunities/
    ├── globals.css        # Глобальні стилі
    ├── layout.tsx         # Кореневий макет
    └── page.tsx           # Головна сторінка

    Групи маршрутів

    • (auth) - Сторінки, пов'язані з автентифікацією
    • (dashboard) - Захищена панель користувача
    • (public) - Публічні маркетингові сторінки

    🧩 Архітектура компонентів

    Ієрархія компонентів

    text
    
    components/
    ├── ui/               # Базові UI компоненти (shadcn/ui)
    │   ├── button.tsx
    │   ├── input.tsx
    │   └── dialog.tsx
    ├── features/         # Компоненти функцій
    │   ├── entities/
    │   ├── opportunities/
    │   └── wallet/
    ├── layout/           # Компоненти макету
    │   ├── navbar.tsx
    │   ├── sidebar.tsx
    │   └── footer.tsx
    └── shared/           # Спільні бізнес-компоненти
        ├── user-avatar.tsx
        └── loading-spinner.tsx

    Патерни компонентів

    1. Базові UI компоненти

    // components/ui/button.tsx

    2. Компоненти функцій

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

    🎯 Архітектура функцій

    Організація на основі функцій

    Патерн модуля функцій

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

    Патерн користувацьких хуків

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

    🔧 Директорія Lib

    Спільні утиліти

    Ключові утиліти

    Конфігурація автентифікації

    // lib/auth.ts

    Утиліти бази даних

    // lib/db.ts

    ⚡ Серверні дії

    Структура серверних дій

    Патерн серверних дій

    📝 Патерни TypeScript

    Організація типів

    // types/entities.ts

    API Response Types

    // types/api.ts

    🎨 Архітектура стилізації

    Організація Tailwind CSS

    Патерни стилізації компонентів

    // Using cn utility for conditional classes

    📚 Найкращі практики

    1. Організація імпортів

    // External imports first

    2. Структура файлів компонентів

    // 1. Imports

    3. Межі функцій

    • Зберігайте код функцій у відповідних директоріях функцій
    • Використовуйте публічні API для міжфункціональної комунікації
    • Уникайте глибоких імпортів з інших функцій

    Далі: Робочий процес розробки - Дізнайтеся про наш Git робочий процес та процес розробки.

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

    Розуміння кодової бази 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

    App Router (Next.js 16)

    text
    
    app/
    ├── (auth)/            # Групи маршрутів для сторінок автентифікації
    │   ├── login/
    │   └── register/
    ├── (dashboard)/       # Захищені маршрути панелі керування
    │   ├── entities/
    │   ├── opportunities/
    │   └── wallet/
    ├── api/               # API маршрути
    │   ├── auth/
    │   ├── entities/
    │   └── opportunities/
    ├── globals.css        # Глобальні стилі
    ├── layout.tsx         # Кореневий макет
    └── page.tsx           # Головна сторінка

    Групи маршрутів

    • (auth) - Сторінки, пов'язані з автентифікацією
    • (dashboard) - Захищена панель користувача
    • (public) - Публічні маркетингові сторінки

    🧩 Архітектура компонентів

    Ієрархія компонентів

    text
    
    components/
    ├── ui/               # Базові UI компоненти (shadcn/ui)
    │   ├── button.tsx
    │   ├── input.tsx
    │   └── dialog.tsx
    ├── features/         # Компоненти функцій
    │   ├── entities/
    │   ├── opportunities/
    │   └── wallet/
    ├── layout/           # Компоненти макету
    │   ├── navbar.tsx
    │   ├── sidebar.tsx
    │   └── footer.tsx
    └── shared/           # Спільні бізнес-компоненти
        ├── user-avatar.tsx
        └── loading-spinner.tsx

    Патерни компонентів

    1. Базові UI компоненти

    // components/ui/button.tsx

    2. Компоненти функцій

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

    🎯 Архітектура функцій

    Організація на основі функцій

    Патерн модуля функцій

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

    Патерн користувацьких хуків

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

    🔧 Директорія Lib

    Спільні утиліти

    Ключові утиліти

    Конфігурація автентифікації

    // lib/auth.ts

    Утиліти бази даних

    // lib/db.ts

    ⚡ Серверні дії

    Структура серверних дій

    Патерн серверних дій

    📝 Патерни TypeScript

    Організація типів

    // types/entities.ts

    API Response Types

    // types/api.ts

    🎨 Архітектура стилізації

    Організація Tailwind CSS

    Патерни стилізації компонентів

    // Using cn utility for conditional classes

    📚 Найкращі практики

    1. Організація імпортів

    // External imports first

    2. Структура файлів компонентів

    // 1. Imports

    3. Межі функцій

    • Зберігайте код функцій у відповідних директоріях функцій
    • Використовуйте публічні API для міжфункціональної комунікації
    • Уникайте глибоких імпортів з інших функцій

    Далі: Робочий процес розробки - Дізнайтеся про наш Git робочий процес та процес розробки.

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

    Розуміння кодової бази 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

    App Router (Next.js 16)

    text
    
    app/
    ├── (auth)/            # Групи маршрутів для сторінок автентифікації
    │   ├── login/
    │   └── register/
    ├── (dashboard)/       # Захищені маршрути панелі керування
    │   ├── entities/
    │   ├── opportunities/
    │   └── wallet/
    ├── api/               # API маршрути
    │   ├── auth/
    │   ├── entities/
    │   └── opportunities/
    ├── globals.css        # Глобальні стилі
    ├── layout.tsx         # Кореневий макет
    └── page.tsx           # Головна сторінка

    Групи маршрутів

    • (auth) - Сторінки, пов'язані з автентифікацією
    • (dashboard) - Захищена панель користувача
    • (public) - Публічні маркетингові сторінки

    🧩 Архітектура компонентів

    Ієрархія компонентів

    text
    
    components/
    ├── ui/               # Базові UI компоненти (shadcn/ui)
    │   ├── button.tsx
    │   ├── input.tsx
    │   └── dialog.tsx
    ├── features/         # Компоненти функцій
    │   ├── entities/
    │   ├── opportunities/
    │   └── wallet/
    ├── layout/           # Компоненти макету
    │   ├── navbar.tsx
    │   ├── sidebar.tsx
    │   └── footer.tsx
    └── shared/           # Спільні бізнес-компоненти
        ├── user-avatar.tsx
        └── loading-spinner.tsx

    Патерни компонентів

    1. Базові UI компоненти

    // components/ui/button.tsx

    2. Компоненти функцій

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

    🎯 Архітектура функцій

    Організація на основі функцій

    Патерн модуля функцій

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

    Патерн користувацьких хуків

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

    🔧 Директорія Lib

    Спільні утиліти

    Ключові утиліти

    Конфігурація автентифікації

    // lib/auth.ts

    Утиліти бази даних

    // lib/db.ts

    ⚡ Серверні дії

    Структура серверних дій

    Патерн серверних дій

    📝 Патерни TypeScript

    Організація типів

    // types/entities.ts

    API Response Types

    // types/api.ts

    🎨 Архітектура стилізації

    Організація Tailwind CSS

    Патерни стилізації компонентів

    // Using cn utility for conditional classes

    📚 Найкращі практики

    1. Організація імпортів

    // External imports first

    2. Структура файлів компонентів

    // 1. Imports

    3. Межі функцій

    • Зберігайте код функцій у відповідних директоріях функцій
    • Використовуйте публічні API для міжфункціональної комунікації
    • Уникайте глибоких імпортів з інших функцій

    Далі: Робочий процес розробки - Дізнайтеся про наш Git робочий процес та процес розробки.

    text
    
    features/
    ├── entities/       # Функція управління сутностями
    │   ├── components/ # Компоненти специфічні для функції
    │   ├── hooks/      # Користувацькі хуки
    │   ├── types/      # TypeScript типи
    │   ├── utils/      # Утиліти функції
    │   └── index.ts    # Публічний API
    ├── opportunities/  # Функція можливостей
    ├── wallet/         # Функція Web3 гаманця
    └── messaging/      # Обмін повідомленнями в реальному часі
    text
    
    lib/
    ├── auth.ts         # Конфігурація Auth.js
    ├── firebase.ts     # Налаштування Firebase
    ├── db.ts           # Утиліти бази даних
    ├── utils.ts        # Загальні утиліти
    ├── validations.ts  # Zod схеми
    ├── constants.ts    # Константи додатку
    └── types.ts        # Глобальні типи
    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/       # Функція управління сутностями
    │   ├── components/ # Компоненти специфічні для функції
    │   ├── hooks/      # Користувацькі хуки
    │   ├── types/      # TypeScript типи
    │   ├── utils/      # Утиліти функції
    │   └── index.ts    # Публічний API
    ├── opportunities/  # Функція можливостей
    ├── wallet/         # Функція Web3 гаманця
    └── messaging/      # Обмін повідомленнями в реальному часі
    text
    
    lib/
    ├── auth.ts         # Конфігурація Auth.js
    ├── firebase.ts     # Налаштування Firebase
    ├── db.ts           # Утиліти бази даних
    ├── utils.ts        # Загальні утиліти
    ├── validations.ts  # Zod схеми
    ├── constants.ts    # Константи додатку
    └── types.ts        # Глобальні типи
    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/       # Функція управління сутностями
    │   ├── components/ # Компоненти специфічні для функції
    │   ├── hooks/      # Користувацькі хуки
    │   ├── types/      # TypeScript типи
    │   ├── utils/      # Утиліти функції
    │   └── index.ts    # Публічний API
    ├── opportunities/  # Функція можливостей
    ├── wallet/         # Функція Web3 гаманця
    └── messaging/      # Обмін повідомленнями в реальному часі
    text
    
    lib/
    ├── auth.ts         # Конфігурація Auth.js
    ├── firebase.ts     # Налаштування Firebase
    ├── db.ts           # Утиліти бази даних
    ├── utils.ts        # Загальні утиліти
    ├── validations.ts  # Zod схеми
    ├── constants.ts    # Константи додатку
    └── types.ts        # Глобальні типи
    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 */