A modern real-time collaboration platform for teams. Chat instantly, share files, and work together seamlessly β all in one place.
- Overview
- Features
- Tech Stack
- Architecture
- Getting Started
- Project Structure
- Environment Variables
- Database Setup
- Deployment
- Contributing
- License
- Author
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.
- β‘ 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
|
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 |
| Technology | Purpose | Version |
|---|---|---|
| Next.js | React Framework | 16.0.10 |
| React | UI Library | 19.2.0 |
| TypeScript | Type Safety | 5.x |
| Technology | Purpose |
|---|---|
| Tailwind CSS | Utility-first CSS |
| shadcn/ui | Component Library |
| Radix UI | Headless Components |
| Framer Motion | Animations |
| Lucide | Icons |
| Technology | Purpose |
|---|---|
| Prisma | ORM |
| PostgreSQL | Database |
| Neon | Serverless Postgres |
| oRPC | Type-safe API Layer |
| Technology | Purpose |
|---|---|
| PartyKit | Real-time WebSockets |
| Cloudflare Workers | Edge Runtime |
| Wrangler | CF CLI |
| Technology | Purpose |
|---|---|
| Kinde | Authentication |
| Arcjet | Security & Rate Limiting |
| Technology | Purpose |
|---|---|
| AI SDK | AI Integration |
| OpenRouter | AI Model Gateway |
| TipTap | Rich Text Editor |
| UploadThing | File Uploads |
| Technology | Purpose |
|---|---|
| TanStack Query | Data Fetching |
| Zod | Validation |
| React Hook Form | Form Management |
| Sonner | Toast Notifications |
βββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ
β 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...) β β β
β β βββββββββββββββββββ βββββββββββββββββββ ββββββββββββββββββββ β β
β ββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ β
ββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ
User Action β React Component β TanStack Query β oRPC Client
β
βΌ
oRPC Server (API)
β
βββββββββββββββββββββββββββββββββββΌββββββββββββββββββββββββββββββββββ
β β β
βΌ βΌ βΌ
Arcjet (Security) Kinde (Auth) AI SDK (OpenRouter)
β β β
βββββββββββββββββββββββββββββββββββΌββββββββββββββββββββββββββββββββββ
β
βΌ
Prisma ORM
β
βΌ
Neon PostgreSQL
Ensure you have the following installed:
- Node.js 20.x or higher
- pnpm (recommended) or npm/yarn
- Git
- 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
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
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"- Create a free account at Neon
- Create a new project
- Copy the connection string
- Add it to your
.env.localfile
# Generate Prisma client
pnpm prisma generate
# Push schema to database
pnpm prisma db push
# Open Prisma Studio (optional)
pnpm prisma studio- Push your code to GitHub
- Import your repository on Vercel
- Add environment variables
- Deploy!
# Or use Vercel CLI
npm i -g vercel
vercel# Login to Cloudflare
pnpm dlx wrangler login
# Deploy wrangler server
pnpm dlx wrangler deploy| 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 |
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
- Follow the existing code style
- Use TypeScript strictly
- Write meaningful commit messages
- Add comments for complex logic
This project is licensed under the MIT License - see the LICENSE file for details.
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.
