Code Structure

Understanding Ring Platform v1.6.0 codebase architecture.

📁 High-Level Architecture

text


ring/
├── app/                    # Next.js 16 App Router (route groups + app/api)
├── components/             # Shared UI, editor, navigation, providers
├── features/               # Domain modules (news, store, auth, …)
├── lib/                    # locale-config, payments/conductor, database, tunnel
├── services/               # email AI CRM, blockchain oracle
├── locales/                # next-intl JSON bundles (en, uk, ru)
├── data/                   # schema.sql + migrations/
├── docs/content/           # MDX documentation library
└── scripts/                # Community setup scripts (OSS)

Not in public OSS tree: k8s/, cli/, propagation/ (gitignored).

🏗️ App Directory Structure

App Router (Next.js 16)

text


app/
├── (public)/[locale]/      # Marketing, news, store, blog
├── (authenticated)/[locale]/  # Editor, entities, settings
├── (admin)/[locale]/       # Admin panels
├── (confidential)/[locale]/ # Tier-gated docs
├── api/                    # 132+ route handlers (auth, store, payments, …)
├── _actions/               # Server actions
├── layout.tsx
└── proxy.ts                # Slim intl proxy (root may use proxy.ts)

Key v1.6.0 modules

Area	Path
PaymentConductor	`lib/payments/conductor/`
News Kingdom	`features/news/services/`, `lib/news/`
Locale SSOT	`lib/locale-config.ts`, `i18n/routing.ts`
Scientific editor	`components/editor/`, `app/api/publications/`
Email CRM	`services/email/`
Member blogs	`app/(public)/[locale]/blog/[username]/`

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

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

Feature Module Pattern

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

Custom Hooks Pattern

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

🔧 Lib Directory

Shared Utilities

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

Key Utilities

Authentication Configuration

// lib/auth.ts

Database Utilities

// lib/db.ts

⚡ Server Actions

Server Actions Structure

text


@actions/
├── entities/
│   ├── create-entity.ts
│   ├── update-entity.ts
│   └── delete-entity.ts
├── opportunities/
└── auth/

Server Action Pattern

📝 TypeScript Patterns

Type Organization

// types/entities.ts

API Response Types

// types/api.ts

🎨 Styling Architecture

Tailwind CSS Organization

text


app/globals.css
├── @tailwind base;
├── @tailwind components;
├── @tailwind utilities;
└── /* Custom component styles */

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.

Loading Documentation Hub...

Scanning documentation library

Documentation

Code Structure

Understanding Ring Platform v1.6.0 codebase architecture.

📁 High-Level Architecture

text


ring/
├── app/                    # Next.js 16 App Router (route groups + app/api)
├── components/             # Shared UI, editor, navigation, providers
├── features/               # Domain modules (news, store, auth, …)
├── lib/                    # locale-config, payments/conductor, database, tunnel
├── services/               # email AI CRM, blockchain oracle
├── locales/                # next-intl JSON bundles (en, uk, ru)
├── data/                   # schema.sql + migrations/
├── docs/content/           # MDX documentation library
└── scripts/                # Community setup scripts (OSS)

Not in public OSS tree: k8s/, cli/, propagation/ (gitignored).

🏗️ App Directory Structure

App Router (Next.js 16)

text


app/
├── (public)/[locale]/      # Marketing, news, store, blog
├── (authenticated)/[locale]/  # Editor, entities, settings
├── (admin)/[locale]/       # Admin panels
├── (confidential)/[locale]/ # Tier-gated docs
├── api/                    # 132+ route handlers (auth, store, payments, …)
├── _actions/               # Server actions
├── layout.tsx
└── proxy.ts                # Slim intl proxy (root may use proxy.ts)

Key v1.6.0 modules

Area	Path
PaymentConductor	`lib/payments/conductor/`
News Kingdom	`features/news/services/`, `lib/news/`
Locale SSOT	`lib/locale-config.ts`, `i18n/routing.ts`
Scientific editor	`components/editor/`, `app/api/publications/`
Email CRM	`services/email/`
Member blogs	`app/(public)/[locale]/blog/[username]/`

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

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

Feature Module Pattern

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

Custom Hooks Pattern

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

🔧 Lib Directory

Shared Utilities

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

Key Utilities

Authentication Configuration

// lib/auth.ts

Database Utilities

// lib/db.ts

⚡ Server Actions

Server Actions Structure

text


@actions/
├── entities/
│   ├── create-entity.ts
│   ├── update-entity.ts
│   └── delete-entity.ts
├── opportunities/
└── auth/

Server Action Pattern

📝 TypeScript Patterns

Type Organization

// types/entities.ts

API Response Types

// types/api.ts

🎨 Styling Architecture

Tailwind CSS Organization

text


app/globals.css
├── @tailwind base;
├── @tailwind components;
├── @tailwind utilities;
└── /* Custom component styles */

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.

Loading Documentation Hub...

Scanning documentation library

Documentation

Welcome — mission & audiences

Welcome to Ring Platform - Gateway Between Humanity and the Quantum World

Library hub

Welcome to Ring Platform - Gateway Between Humanity and the Quantum World

Getting Started

First Success Validation

Troubleshooting

Next Steps

Architecture

Index

Backend modes and databases

Data Model

Authentication Architecture

Email AI-CRM Architecture

PaymentConductor architecture

Refcodes architecture

News Kingdom architecture

Features

Push Notifications with FCM (Ring-Powered)

Web3 Wallet

API

CLI

Ring CLI (enterprise only)

Customization

Deployment

Index

Self-hosted deployment

Vercel

Docker

Environment Configuration

Monitoring & Analytics

Performance Optimization

Backup & Recovery

Development

Generative Images (ImageConductor)

Autonomous Newsroom (Grok)

OSS vs enterprise

Roadmap

Platform Roadmap (Technical)

Examples

Index

Quick Start

Authentication

Email AI-CRM Tutorial

Integrations

Ethereum wallets (Wagmi v3)

Quick entry (CTOs · auditors · agents)

Library hub

Welcome — mission & audiences

Getting started

Architecture & Auth.js

Backend modes & databases (DB_BACKEND_MODE)

Self-hosted

Ring MCP

Deploy (Docker · k8s)

Security & compliance reads

Code Structure

Understanding Ring Platform v1.6.0 codebase architecture.

📁 High-Level Architecture

text


ring/
├── app/                    # Next.js 16 App Router (route groups + app/api)
├── components/             # Shared UI, editor, navigation, providers
├── features/               # Domain modules (news, store, auth, …)
├── lib/                    # locale-config, payments/conductor, database, tunnel
├── services/               # email AI CRM, blockchain oracle
├── locales/                # next-intl JSON bundles (en, uk, ru)
├── data/                   # schema.sql + migrations/
├── docs/content/           # MDX documentation library
└── scripts/                # Community setup scripts (OSS)

Not in public OSS tree: k8s/, cli/, propagation/ (gitignored).

🏗️ App Directory Structure

App Router (Next.js 16)

text


app/
├── (public)/[locale]/      # Marketing, news, store, blog
├── (authenticated)/[locale]/  # Editor, entities, settings
├── (admin)/[locale]/       # Admin panels
├── (confidential)/[locale]/ # Tier-gated docs
├── api/                    # 132+ route handlers (auth, store, payments, …)
├── _actions/               # Server actions
├── layout.tsx
└── proxy.ts                # Slim intl proxy (root may use proxy.ts)

Key v1.6.0 modules

Area	Path
PaymentConductor	`lib/payments/conductor/`
News Kingdom	`features/news/services/`, `lib/news/`
Locale SSOT	`lib/locale-config.ts`, `i18n/routing.ts`
Scientific editor	`components/editor/`, `app/api/publications/`
Email CRM	`services/email/`
Member blogs	`app/(public)/[locale]/blog/[username]/`

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

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

Feature Module Pattern

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

Custom Hooks Pattern

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

🔧 Lib Directory

Shared Utilities

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

Key Utilities

Authentication Configuration

// lib/auth.ts

Database Utilities

// lib/db.ts

⚡ Server Actions

Server Actions Structure

text


@actions/
├── entities/
│   ├── create-entity.ts
│   ├── update-entity.ts
│   └── delete-entity.ts
├── opportunities/
└── auth/

Server Action Pattern

📝 TypeScript Patterns

Type Organization

// types/entities.ts

API Response Types

// types/api.ts

🎨 Styling Architecture

Tailwind CSS Organization

text


app/globals.css
├── @tailwind base;
├── @tailwind components;
├── @tailwind utilities;
└── /* Custom component styles */

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.

Loading Documentation Hub...

Scanning documentation library

Documentation

Welcome — mission & audiences

Welcome to Ring Platform - Gateway Between Humanity and the Quantum World

Library hub

Welcome to Ring Platform - Gateway Between Humanity and the Quantum World

Getting Started

First Success Validation

Troubleshooting

Next Steps

Architecture

Index

Backend modes and databases

Data Model

Authentication Architecture

Email AI-CRM Architecture

PaymentConductor architecture

Refcodes architecture

News Kingdom architecture

Features

Push Notifications with FCM (Ring-Powered)

Web3 Wallet

API

CLI

Ring CLI (enterprise only)

Customization

Deployment

Index

Self-hosted deployment

Vercel

Docker

Environment Configuration

Monitoring & Analytics

Performance Optimization

Backup & Recovery

Development

Generative Images (ImageConductor)

Autonomous Newsroom (Grok)

OSS vs enterprise

Roadmap

Platform Roadmap (Technical)

Examples

Index

Quick Start

Authentication

Email AI-CRM Tutorial

Integrations

Ethereum wallets (Wagmi v3)

Quick entry (CTOs · auditors · agents)

Library hub

Welcome — mission & audiences

Getting started

Architecture & Auth.js

Backend modes & databases (DB_BACKEND_MODE)

Self-hosted

Ring MCP

Deploy (Docker · k8s)

Security & compliance reads