---
title: "Index"
description: "Index documentation for Ring Platform"
locale: "en"
---
# Development Guide

Welcome to the Ring Platform development guide. This section covers everything you need to know about developing with and contributing to Ring Platform.

## 🛠️ Development Setup

### Prerequisites
- Node.js 20 or later (22 recommended)
- npm or pnpm package manager
- Git for version control
- MongoDB (optional, for local development)

### Quick Start

Clone the repository Install dependencies Set up environment variables Run development server

{`git clone https://github.com/connectplatform/ring.git
cd ring

npm install

cp env.local.template .env.local

npm run dev`}

## 📁 Project Structure

```
ring/
├── app/             # Next.js 16 App Router
├── components/      # React components
├── lib/             # Utility functions
├── features/        # Feature modules
├── @actions/        # Server actions
├── public/          # Static assets
└── AI-CONTEXT/      # AI documentation
```

## 🔧 Development Workflow

### Local Development
- [Local Setup](/en/docs/development/local-setup) - Complete local environment setup
- [Community tooling](/en/docs/development/community-tooling) - `install.sh` (no Ring CLI in OSS)
- [Ring MCP](/en/docs/development/ring-mcp) - Operate clones via `AI-RING/ring-mcp` (57 tools)
- [Generative images](/en/docs/development/generative-images) - ImageConductor (xAI / Google Imagen)
- [Autonomous newsroom](/en/docs/development/generative-newsroom) - Grok cited articles, TTS, Telegram approval
- [Code Structure](/en/docs/development/code-structure) - Understanding the codebase
- [Documentation components](/docs/development/docs-components.md) - MDX component library (Callout, Mermaid, Tabs, Cards, Steps)
- [Whitelabel Navigation](/en/docs/development/whitelabel-navigation) - Custom navigation for Ring clones
- [Best Practices](/en/docs/development/best-practices) - Coding standards and patterns

### Testing & Quality
- [Testing](/en/docs/development/testing) - Unit and integration testing
- [Debugging](/en/docs/development/debugging) - Debugging techniques and tools
- [Contributing](/en/docs/development/contributing) - How to contribute to Ring Platform

## 🚀 Key Technologies

- **React 19** - Latest React features
- **Next.js 16** - App Router and Server Components
- **TypeScript** - Type safety and better DX
- **Tailwind CSS v4** - Utility-first styling
- **Auth.js v5** - Authentication
- **Firebase** - Backend services

## 📚 Resources

- [API Documentation](/en/docs/api) - Complete API reference
- [Feature Guides](/en/docs/features) - Deep dive into features
- [Examples](/en/docs/examples) - Code examples and patterns

---

*Ready to start developing? Begin with [Local Setup](/en/docs/development/local-setup).*