Skip to content

Commit 4ad6493

Browse files
authored
Update README.md
1 parent 751135f commit 4ad6493

1 file changed

Lines changed: 108 additions & 79 deletions

File tree

README.md

Lines changed: 108 additions & 79 deletions
Original file line numberDiff line numberDiff line change
@@ -1,57 +1,75 @@
1-
🚀 CodeSphere
2-
CodeSphere is a real-time collaborative coding platform built with Next.js, TypeScript, and PostgreSQL. It brings together features of an online IDE, Git version control, and AI-powered coding assistance — all in the browser.
3-
Think of it as a VS Code in your browser, with real-time collaboration, presence indicators, AI coding assistant, and even voice chat.
4-
✨ Features
5-
🔐 Authentication
6-
Google login with NextAuth.js
7-
Secure session handling
8-
👥 Real-time Collaboration
9-
Multi-user code editing powered by Monaco Editor
10-
Presence indicators (see who’s online in a room)
11-
Local undo/redo per file
12-
🗂 File & Room Management
13-
Room-based collaboration spaces
14-
File explorer with folder nesting
15-
Full CRUD operations (add, rename, delete files/folders)
16-
File icons (VS Code–style)
17-
📦 Dependencies & Preview
18-
Add external dependencies (Lodash, DayJs, UUID, etc.) per room
19-
Live preview with injected dependencies
20-
Support for multiple languages and file types
21-
🕓 Version Control (Git-style)
22-
Commit changes with messages
23-
Browse commit history & details
24-
Revert to specific commits
25-
Sidebar UI with dedicated Version Control tab
26-
🤖 AI Integration
27-
AI-powered code assistant using OpenAI API
28-
Context-aware code explanations
29-
Code refactor
30-
Debug errors
31-
Add useful comments
32-
🗣 Communication
33-
Built-in voice chat for real-time collaboration
34-
🎨 Other Enhancements
35-
Syntax highlighting with language switch
36-
Side-by-side Markdown rendering
37-
Multiple beautiful themes
38-
Deployed on Vercel (frontend)
39-
🛠️ Tech Stack
40-
Frontend: Next.js + TypeScript
41-
Database: PostgreSQL with Prisma ORM
42-
Authentication: NextAuth.js with Google Provider
43-
Editor: Monaco Editor
44-
Collaboration: Socket.IO
45-
AI: OpenAI API
46-
UI/UX: TailwindCSS, shadcn/ui, lucide-react
47-
Deployment: Vercel, Docker
48-
Download full project as ZIP or use package.json with dependencies
49-
50-
51-
52-
📦 Getting Started
53-
54-
1. Clone the repo
1+
# 🚀 CodeSphere
2+
3+
**CodeSphere** is a real-time collaborative coding platform built with **Next.js**, **TypeScript**, and **PostgreSQL**.
4+
It brings together features of an online IDE, Git version control, and AI-powered coding assistance — all in the browser.
5+
6+
Think of it as a **VS Code in your browser**, with real-time collaboration, presence indicators, AI coding assistant, and even voice chat.
7+
8+
---
9+
10+
## ✨ Features
11+
12+
### 🔐 Authentication
13+
- Google login with **NextAuth.js**
14+
- Secure session handling
15+
16+
### 👥 Real-time Collaboration
17+
- Multi-user code editing powered by **Monaco Editor**
18+
- Presence indicators (see who’s online in a room)
19+
- Local undo/redo per file
20+
21+
### 🗂 File & Room Management
22+
- Room-based collaboration spaces
23+
- File explorer with folder nesting
24+
- Full CRUD operations (add, rename, delete files/folders)
25+
- File icons (VS Code–style)
26+
27+
### 📦 Dependencies & Preview
28+
- Add external dependencies (Lodash, DayJs, UUID, etc.) per room
29+
- Live preview with injected dependencies
30+
- Support for multiple languages and file types
31+
32+
### 🕓 Version Control (Git-style)
33+
- Commit changes with messages
34+
- Browse commit history & details
35+
- Revert to specific commits
36+
- Sidebar UI with dedicated Version Control tab
37+
38+
### 🤖 AI Integration
39+
- AI-powered code assistant using **OpenAI API**
40+
- Context-aware code explanations
41+
- Code refactor
42+
- Debug errors
43+
- Add useful comments
44+
45+
### 🗣 Communication
46+
- Built-in **voice chat** for real-time collaboration
47+
48+
### 🎨 Other Enhancements
49+
- Syntax highlighting with language switch
50+
- Side-by-side Markdown rendering
51+
- Multiple beautiful themes
52+
- Deployed on **Vercel** (frontend)
53+
- Download full project as ZIP or use `package.json` with dependencies
54+
55+
---
56+
57+
## 🛠️ Tech Stack
58+
59+
- **Frontend**: Next.js + TypeScript
60+
- **Database**: PostgreSQL with Prisma ORM
61+
- **Authentication**: NextAuth.js with Google Provider
62+
- **Editor**: Monaco Editor
63+
- **Collaboration**: Socket.IO
64+
- **AI**: OpenAI API
65+
- **UI/UX**: TailwindCSS, shadcn/ui, lucide-react
66+
- **Deployment**: Vercel, Docker
67+
68+
---
69+
70+
## 📦 Getting Started
71+
72+
### 1. Clone the repo
5573
```bash
5674
git clone https://github.com/Sagar141005/CodeSphere.git
5775
cd CodeSphere
@@ -85,28 +103,39 @@ npx prisma migrate dev
85103
npm run dev
86104
```
87105

88-
🌍 Deployment
89-
• Frontend: Vercel
90-
• Database: Hosted PostgreSQL (Supabase)
91-
92-
🛠️ Upcoming Features / TODO
93-
GitHub Integration
94-
• Push commits directly to GitHub.
95-
• Clone public repos into a room.
96-
Advanced AI Features
97-
• AI pair programming mode.
98-
• AI test case generation.
99-
Video Chat
100-
• In-room video calls (alongside voice chat).
101-
More Language Runtimes
102-
• Add runtime support for Python, Java, C/C++.
103-
Collaboration Enhancements
104-
• Commenting system (inline code comments).
105-
@mentions and notifications.
106-
Mobile & Tablet Optimizations
107-
• Touch-based editing.
108-
• Mobile-friendly sidebar & preview.
109-
110-
111-
🤝 Contributing
112-
This project was built solo as a portfolio project, but contributions, feedback, and ideas are welcome.
106+
## 🌍 Deployment
107+
108+
- **Frontend**: Vercel
109+
- **Database**: Hosted PostgreSQL (e.g., Supabase)
110+
111+
---
112+
113+
## 🧪 Upcoming Features / TODO
114+
115+
### 🔗 GitHub Integration
116+
- Push commits directly to GitHub
117+
- Clone public repos into a room
118+
119+
### 🤖 Advanced AI Features
120+
- AI pair programming mode
121+
- AI test case generation
122+
123+
### 🎥 Video Chat
124+
- In-room video calls (alongside voice chat)
125+
126+
### 🧑‍💻 More Language Runtimes
127+
- Add runtime support for **Python**, **Java**, **C/C++**
128+
129+
### 💬 Collaboration Enhancements
130+
- Inline code commenting system
131+
- `@mentions` and notifications
132+
133+
### 📱 Mobile & Tablet Optimizations
134+
- Touch-based editing
135+
- Mobile-friendly sidebar & preview
136+
137+
---
138+
139+
## 🤝 Contributing
140+
141+
This project was built solo as a **portfolio project**, but **contributions, feedback, and ideas are welcome**!

0 commit comments

Comments
 (0)