Revo is an open-source real-time collaboration platform.

🚀 Revo

Connect. Collaborate. Create.

A modern real-time collaboration platform for teams. Chat instantly, share files, and work together seamlessly — all in one place.

Live Demo · Report Bug · Request Feature

📖 Table of Contents

Overview
Features
Tech Stack
Architecture
Getting Started
Project Structure
Environment Variables
Database Setup
Deployment
Contributing
License
Author

🌟 Overview

Revo is a next-generation team collaboration platform designed for modern remote and hybrid teams. Built with cutting-edge technologies, it offers real-time messaging, threaded discussions, file sharing, and AI-powered features — all wrapped in a beautiful, responsive interface.

Why Revo?

⚡ Blazing Fast — Built on Next.js 16 with React 19 for optimal performance
🔒 Secure — Enterprise-grade security with Arcjet protection and Kinde authentication
🤖 AI-Powered — Integrated AI assistance powered by OpenRouter
🌐 Real-time — WebSocket-powered instant messaging via PartyKit
📱 Responsive — Beautiful UI that works seamlessly across all devices

✨ Features

Channel Management _{Create organized spaces for teams, projects, or topics}	Team Collaboration _{Invite teammates and collaborate in real-time}	Instant Messaging _{Send messages, share ideas, and stay connected}
Threaded Discussions _{Keep detailed conversations organized with threads}	Reactions & Engagement _{React with emojis to quickly respond and engage}	AI Assistant _{Get help with writing, summarizing, and more}
File Sharing _{Upload and share files seamlessly with UploadThing}	Rich Text Editor _{Format messages with TipTap's powerful editor}	Dark/Light Mode _{Beautiful themes that adapt to your preference}

🛠 Tech Stack

Core Framework

Technology	Purpose	Version
Next.js	React Framework	16.0.10
React	UI Library	19.2.0
TypeScript	Type Safety	5.x

Styling & UI

Technology	Purpose
Tailwind CSS	Utility-first CSS
shadcn/ui	Component Library
Radix UI	Headless Components
Framer Motion	Animations
Lucide	Icons

Backend & Database

Technology	Purpose
Prisma	ORM
PostgreSQL	Database
Neon	Serverless Postgres
oRPC	Type-safe API Layer

Real-time & Infrastructure

Technology	Purpose
PartyKit	Real-time WebSockets
Cloudflare Workers	Edge Runtime
Wrangler	CF CLI

Authentication & Security

Technology	Purpose
Kinde	Authentication
Arcjet	Security & Rate Limiting

AI & Content

Technology	Purpose
AI SDK	AI Integration
OpenRouter	AI Model Gateway
TipTap	Rich Text Editor
UploadThing	File Uploads

Developer Experience

Technology	Purpose
TanStack Query	Data Fetching
Zod	Validation
React Hook Form	Form Management
Sonner	Toast Notifications

🏗 Architecture

┌─────────────────────────────────────────────────────────────────────────────┐
│                                   CLIENT                                    │
│  ┌─────────────────────────────────────────────────────────────────────┐    │
│  │                         Next.js 16 App Router                       │    │
│  │  ┌─────────────┐  ┌─────────────┐  ┌─────────────┐  ┌────────────┐  │    │
│  │  │   React 19  │  │  TanStack   │  │   shadcn/ui │  │   Motion   │  │    │
│  │  │ Components  │  │    Query    │  │  + Radix UI │  │ Animations │  │    │
│  │  └─────────────┘  └─────────────┘  └─────────────┘  └────────────┘  │    │
│  └─────────────────────────────────────────────────────────────────────┘    │
└─────────────────────────────────────────────────────────────────────────────┘
                                      │
                    ┌─────────────────┼─────────────────┐
                    ▼                 ▼                 ▼
        ┌───────────────────┐ ┌───────────────┐ ┌───────────────────┐
        │    oRPC Client    │ │  PartySocket  │ │    UploadThing    │
        │   (Type-safe)     │ │  (Real-time)  │ │   (File Upload)   │
        └─────────┬─────────┘ └───────┬───────┘ └─────────┬─────────┘
                  │                   │                   │
┌─────────────────┼───────────────────┼───────────────────┼─────────────────┐
│                 │                   │                   │      EDGE       │
│                 ▼                   ▼                   ▼                 │
│  ┌──────────────────────────────────────────────────────────────────┐     │
│  │                        Cloudflare Workers                        │     │
│  │  ┌─────────────────┐  ┌─────────────────┐  ┌──────────────────┐  │     │
│  │  │   PartyServer   │  │     Wrangler    │  │   Edge Runtime   │  │     │ 
│  │  │   (WebSocket)   │  │   (Deployment)  │  │   (Low Latency)  │  │     │
│  │  └─────────────────┘  └─────────────────┘  └──────────────────┘  │     │
│  └──────────────────────────────────────────────────────────────────┘     │
└──────────────────────────────────────────────────────────────────────────-┘
                                      │
┌─────────────────────────────────────┼────────────────────────────────────┐
│                                     │              SERVER                │
│  ┌──────────────────────────────────┼───────────────────────────────┐    │
│  │                         Next.js API Layer                        │    │
│  │  ┌─────────────────┐  ┌─────────────────┐  ┌──────────────────┐  │    │
│  │  │   oRPC Server   │  │     Arcjet      │  │   Kinde Auth     │  │    │
│  │  │  (Procedures)   │  │   (Security)    │  │ (Authentication) │  │    │
│  │  └────────┬────────┘  └─────────────────┘  └──────────────────┘  │    │
│  └───────────┼──────────────────────────────────────────────────────┘    │
│              │                                                           │
│              ▼                                                           │
│  ┌──────────────────────────────────────────────────────────────────┐    │
│  │                         Prisma ORM                               │    │
│  │  ┌─────────────────┐  ┌─────────────────┐  ┌──────────────────┐  │    │
│  │  │     Models      │  │    Migrations   │  │  Query Builder   │  │    │
│  │  └────────┬────────┘  └─────────────────┘  └──────────────────┘  │    │
│  └───────────┼──────────────────────────────────────────────────────┘    │
│              │                                                           │
│              ▼                                                           │
│  ┌──────────────────────────────────────────────────────────────────┐    │
│  │                      Neon PostgreSQL                             │    │
│  │  ┌─────────────────┐  ┌─────────────────┐  ┌──────────────────┐  │    │
│  │  │   Serverless    │  │    Branching    │  │   Auto-scaling   │  │    │
│  │  └─────────────────┘  └─────────────────┘  └──────────────────┘  │    │
│  └──────────────────────────────────────────────────────────────────┘    │
└──────────────────────────────────────────────────────────────────────────┘
                                      │
┌─────────────────────────────────────┼────────────────────────────────────┐
│                                     │           AI SERVICES              │
│  ┌──────────────────────────────────┼───────────────────────────────┐    │
│  │  ┌─────────────────┐  ┌─────────────────┐  ┌──────────────────┐  │    │
│  │  │     AI SDK      │  │   OpenRouter    │  │   LLM Models     │  │    │
│  │  │   (Vercel)      │  │    (Gateway)    │  │ (GPT, Claude...) │  │    │
│  │  └─────────────────┘  └─────────────────┘  └──────────────────┘  │    │
│  └──────────────────────────────────────────────────────────────────┘    │
└──────────────────────────────────────────────────────────────────────────┘

Data Flow

User Action → React Component → TanStack Query → oRPC Client
                                                      │
                                                      ▼
                                              oRPC Server (API)
                                                      │
                    ┌─────────────────────────────────┼─────────────────────────────────┐
                    │                                 │                                 │
                    ▼                                 ▼                                 ▼
            Arcjet (Security)                  Kinde (Auth)                    AI SDK (OpenRouter)
                    │                                 │                                 │
                    └─────────────────────────────────┼─────────────────────────────────┘
                                                      │
                                                      ▼
                                              Prisma ORM
                                                      │
                                                      ▼
                                              Neon PostgreSQL

🚀 Getting Started

Prerequisites

Ensure you have the following installed:

Node.js 20.x or higher
pnpm (recommended) or npm/yarn
Git

Installation

Clone the repository

git clone https://github.com/Devsethi3/revo.git
cd revo

Install dependencies

pnpm install
# or
npm install

Set up environment variables

cp .env.example .env.local

Set up the database

pnpm prisma generate
pnpm prisma db push

Run the development server

pnpm dev

Open your browser

Navigate to http://localhost:3000

📁 Project Structure

revo/
├── app/                          # Next.js App Router
│   ├── (auth)/                   # Authentication routes
│   ├── (main)/                   # Main application routes
│   ├── api/                      # API routes
│   │   ├── orpc/                 # oRPC handlers
│   │   ├── uploadthing/          # File upload handlers
│   │   └── ai/                   # AI endpoints
│   ├── layout.tsx                # Root layout
│   └── page.tsx                  # Landing page
│
├── components/                   # React components
│   ├── ui/                       # shadcn/ui components
│   ├── auth/                     # Authentication components
│   ├── chat/                     # Chat components
│   ├── channels/                 # Channel components
│   ├── editor/                   # TipTap editor components
│   └── theme/                    # Theme provider
│
├── lib/                          # Utility functions
│   ├── orpc/                     # oRPC configuration
│   │   ├── client.ts             # Client setup
│   │   ├── server.ts             # Server setup
│   │   └── router.ts             # API router
│   ├── prisma.ts                 # Prisma client
│   ├── auth.ts                   # Kinde helpers
│   ├── ai.ts                     # AI SDK setup
│   └── utils.ts                  # Utility functions
│
├── server/                       # Server-side code
│   ├── procedures/               # oRPC procedures
│   └── party/                    # PartyKit server
│
├── prisma/                       # Database
│   └── schema.prisma             # Database schema
│
├── public/                       # Static assets
│   ├── revo-showcase.png         # OG image
│   └── favicon.ico               # Favicon
│
├── types/                        # TypeScript types
│
├── .env.example                  # Environment template
├── next.config.ts                # Next.js config
├── tailwind.config.ts            # Tailwind config
├── tsconfig.json                 # TypeScript config
├── wrangler.toml                 # Cloudflare config
└── package.json                  # Dependencies

🔐 Environment Variables

Create a .env.local file in the root directory:

# ===========================================
# DATABASE
# ===========================================
DATABASE_URL="postgresql://user:password@host:5432/revo?sslmode=require"

# ===========================================
# KINDE AUTHENTICATION
# ===========================================
KINDE_CLIENT_ID="your_kinde_client_id"
KINDE_CLIENT_SECRET="your_kinde_client_secret"
KINDE_ISSUER_URL="https://your-domain.kinde.com"
KINDE_SITE_URL="http://localhost:3000"
KINDE_POST_LOGOUT_REDIRECT_URL="http://localhost:3000"
KINDE_POST_LOGIN_REDIRECT_URL="http://localhost:3000/workspace"
KINDE_DOMAIN=https://your-domain.kinde.com
KINDE_MANAGEMENT_CLIENT_ID="your_kinde_management_id"
KINDE_MANAGEMENT_CLIENT_SECRET="your_kinde_management_secret"

# ===========================================
# UPLOADTHING
# ===========================================
UPLOADTHING_TOKEN="your_uploadthing_token"

# ===========================================
# AI / OPENROUTER
# ===========================================
OPENROUTER_LLM_KEY="your_openrouter_api_key"

# ===========================================
# ARCJET (Security)
# ===========================================
ARCJET_KEY="your_arcjet_key"

# ===========================================
# APP
# ===========================================
NEXT_PUBLIC_APP_URL="http://localhost:3000"

🗄 Database Setup

Using Neon (Recommended)

Create a free account at Neon
Create a new project
Copy the connection string
Add it to your .env.local file

Run Migrations

# Generate Prisma client
pnpm prisma generate

# Push schema to database
pnpm prisma db push

# Open Prisma Studio (optional)
pnpm prisma studio

🚀 Deployment

Vercel (Recommended)

Push your code to GitHub
Import your repository on Vercel
Add environment variables
Deploy!

# Or use Vercel CLI
npm i -g vercel
vercel

Cloudflare Workers (PartyKit)

# Login to Cloudflare
pnpm dlx wrangler login

# Deploy wrangler server
pnpm dlx wrangler deploy

🧪 Scripts

Command	Description
`pnpm dev`	Start development server
`pnpm build`	Build for production
`pnpm start`	Start production server
`pnpm lint`	Run ESLint
`pnpm prisma studio`	Open Prisma Studio
`pnpm prisma generate`	Generate Prisma client
`pnpm prisma db push`	Push schema to database

🤝 Contributing

Contributions are welcome! Please follow these steps:

Fork the repository
Create a feature branch
```
git checkout -b feature/amazing-feature
```
Commit your changes
```
git commit -m 'Add amazing feature'
```
Push to the branch
```
git push origin feature/amazing-feature
```
Open a Pull Request

Code Style

Follow the existing code style
Use TypeScript strictly
Write meaningful commit messages
Add comments for complex logic

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

👨‍💻 Author

Dev Prasad Sethi

⭐ Star this repo if you find it useful!

Made with ❤️ and ☕

`LICENSE` (MIT)

MIT License

Copyright (c) 2024 Dev Prasad Sethi

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

Name		Name	Last commit message	Last commit date
Latest commit History 120 Commits
app		app
components		components
hooks		hooks
lib		lib
prisma		prisma
providers		providers
public		public
realtime		realtime
.env.example		.env.example
.gitignore		.gitignore
README.md		README.md
components.json		components.json
eslint.config.mjs		eslint.config.mjs
instrumentation.ts		instrumentation.ts
middleware.ts		middleware.ts
next.config.ts		next.config.ts
package.json		package.json
pnpm-lock.yaml		pnpm-lock.yaml
postcss.config.mjs		postcss.config.mjs
prisma.config.ts		prisma.config.ts
tsconfig.json		tsconfig.json
worker-configuration.d.ts		worker-configuration.d.ts
wrangler.json		wrangler.json

Devsethi3/Revo

Folders and files

Latest commit

History

Repository files navigation