Getting Started

Welcome to Ring Platform! This guide will help you get up and running in minutes.

Quick Start (5 minutes)

1

Clone the repository

bash

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

2

Install dependencies

bash

npm install

This installs all required packages including React 19, Next.js 15, and all platform dependencies (~2-3 minutes).

3

Configure environment

bash

npm run setup:env

Creates .env.local with default configuration. You can customize database, auth providers, and features later.

4

Start development server

bash

npm run dev

Launches the platform on http://localhost:3000. First start may take ~30 seconds to compile.

✅ Success! Visit http://localhost:3000 to see your Ring Platform instance.

What's Next?

Prerequisites - System requirements
Installation - Detailed setup guide
First Success - Validate your setup
Troubleshooting - Common issues

Getting Started

Welcome to Ring Platform! This guide will help you get up and running in minutes.

Quick Start (5 minutes)

1

Clone the repository

bash

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

2

Install dependencies

bash

npm install

This installs all required packages including React 19, Next.js 15, and all platform dependencies (~2-3 minutes).

3

Configure environment

bash

npm run setup:env

Creates .env.local with default configuration. You can customize database, auth providers, and features later.

4

Start development server

bash

npm run dev

Launches the platform on http://localhost:3000. First start may take ~30 seconds to compile.

✅ Success! Visit http://localhost:3000 to see your Ring Platform instance.

What's Next?

Prerequisites - System requirements
Installation - Detailed setup guide
First Success - Validate your setup
Troubleshooting - Common issues

Getting Started

Welcome to Ring Platform! This guide will help you get up and running in minutes.

Quick Start (5 minutes)

1

Clone the repository

bash

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

2

Install dependencies

bash

npm install

This installs all required packages including React 19, Next.js 15, and all platform dependencies (~2-3 minutes).

3

Configure environment

bash

npm run setup:env

Creates .env.local with default configuration. You can customize database, auth providers, and features later.

4

Start development server

bash

npm run dev

Launches the platform on http://localhost:3000. First start may take ~30 seconds to compile.

✅ Success! Visit http://localhost:3000 to see your Ring Platform instance.

What's Next?