Skip to content

Commit 2b54b9b

Browse files
authored
Merge pull request #234 from DevanshuNEU/chore/pre-launch-polish
chore: pre-launch polish - branding, favicon, README rewrite
2 parents a0cdbb8 + d516ea4 commit 2b54b9b

9 files changed

Lines changed: 151 additions & 55 deletions

File tree

README.md

Lines changed: 131 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -1,88 +1,126 @@
11
<p align="center">
2-
<!-- Logo placeholder - replace with actual logo -->
3-
<h1 align="center">OpenCodeIntel</h1>
2+
<img src="docs/assets/OpenCodeIntel_Fav.png" alt="OpenCodeIntel" width="80" />
3+
</p>
4+
5+
<h1 align="center">OpenCodeIntel</h1>
6+
7+
<p align="center">
8+
<strong>Stop feeling lost in unfamiliar codebases.</strong><br/>
9+
Semantic code search powered by AI. Find anything, instantly.
410
</p>
511

612
<p align="center">
7-
<strong>Finally understand your codebase</strong>
13+
<a href="https://opencodeintel.com"><strong>Try it Free</strong></a>
14+
&nbsp;&nbsp;·&nbsp;&nbsp;
15+
<a href="#quick-start">Self-Host</a>
16+
&nbsp;&nbsp;·&nbsp;&nbsp;
17+
<a href="./docs">Docs</a>
18+
&nbsp;&nbsp;·&nbsp;&nbsp;
19+
<a href="./CONTRIBUTING.md">Contribute</a>
820
</p>
921

1022
<p align="center">
1123
<a href="https://github.com/OpenCodeIntel/opencodeintel/actions/workflows/ci.yml">
12-
<img src="https://github.com/OpenCodeIntel/opencodeintel/actions/workflows/ci.yml/badge.svg" alt="CI Status" />
24+
<img src="https://github.com/OpenCodeIntel/opencodeintel/actions/workflows/ci.yml/badge.svg" alt="CI" />
1325
</a>
1426
<a href="https://github.com/OpenCodeIntel/opencodeintel/blob/main/LICENSE">
1527
<img src="https://img.shields.io/github/license/OpenCodeIntel/opencodeintel" alt="License" />
1628
</a>
17-
<a href="https://github.com/OpenCodeIntel/opencodeintel/releases">
18-
<img src="https://img.shields.io/github/v/release/OpenCodeIntel/opencodeintel?include_prereleases" alt="Release" />
29+
<a href="https://github.com/OpenCodeIntel/opencodeintel/stargazers">
30+
<img src="https://img.shields.io/github/stars/OpenCodeIntel/opencodeintel?style=social" alt="Stars" />
1931
</a>
2032
</p>
2133

34+
<br/>
35+
2236
<p align="center">
23-
<a href="#quick-start">Quick Start</a> •
24-
<a href="./docs/deployment.md">Docs</a> •
25-
<a href="./CONTRIBUTING.md">Contributing</a>
37+
<img src="docs/assets/hero.png" alt="OpenCodeIntel Demo" width="800" />
2638
</p>
2739

2840
---
2941

30-
You know that mass of code you inherited? The one where you spend 20 minutes grep-ing just to find where authentication happens? Where you're scared to change anything because you don't know what might break?
42+
## The Problem
43+
44+
You know the feeling. Day one on a new codebase. Deadline in two weeks.
3145

32-
**OpenCodeIntel fixes that.**
46+
You need to find "where authentication happens" but the function is called `validateSessionToken()`. Grep for "auth" and you get nothing. You spend 20 minutes clicking through files, afraid to touch anything because you don't know what might break.
3347

34-
Search your code by what it *does*, not what it's named. Ask for "error handling" and find it—even when the function is called `processFailure()`.
48+
Traditional code search matches text, not meaning. You have to already know what you're looking for to find it.
3549

36-
<!-- Demo screenshot placeholder -->
37-
<!-- <p align="center">
38-
<img src="docs/assets/demo.png" alt="OpenCodeIntel Demo" width="800" />
39-
</p> -->
50+
---
4051

41-
## See it in action
52+
## The Solution
4253

43-
| You search for... | It finds... |
44-
|-------------------|-------------|
45-
| `"authentication logic"` | `validateJWT()`, `checkSession()`, `authMiddleware.ts` |
46-
| `"where we handle payments"` | `stripe/checkout.ts`, `processRefund()`, `PaymentService` |
47-
| `"error handling"` | `processFailure()`, `onError()`, `catch` blocks across the codebase |
54+
OpenCodeIntel understands your code the way you do. Search by what code *does*, not what it's named.
55+
56+
```text
57+
You search: "authentication logic"
58+
It finds: validateSessionToken(), checkJWT(), authMiddleware.ts
59+
```
60+
61+
```text
62+
You search: "where we handle payments"
63+
It finds: stripe/checkout.ts, processRefund(), PaymentService
64+
```
65+
66+
```text
67+
You search: "error handling"
68+
It finds: catch blocks, onError(), processFailure()
69+
```
4870

4971
No regex. No exact matches. Just describe what you're looking for.
5072

51-
## What else?
73+
---
74+
75+
## Features
76+
77+
### Semantic Code Search
78+
Search by meaning, not keywords. Find that function even when you don't know its name.
5279

53-
**Dependency Graph** — See how your files connect. One glance shows you the architecture.
80+
### Dependency Graph
81+
Visualize how your files connect. Understand the architecture at a glance.
5482

55-
**Impact Analysis** — About to change `auth.ts`? Know exactly what breaks before you touch it.
83+
### Impact Analysis
84+
About to change `auth.ts`? Know exactly what breaks before you touch it.
5685

57-
**Code Style** — Understand your team's patterns. snake_case or camelCase? How are errors handled?
86+
### Code Style Intelligence
87+
Understand your team's patterns. snake_case or camelCase? How are errors handled? Match conventions instantly.
5888

59-
**Works with Claude** — Connects as an MCP server. Your AI assistant finally understands your codebase.
89+
### Works with Claude (MCP)
90+
Connect as an MCP server. Your AI assistant gets real context about your codebase, not just the file you have open.
91+
92+
---
6093

6194
## Quick Start
6295

96+
### Hosted (Fastest)
97+
98+
Go to [opencodeintel.com](https://opencodeintel.com), connect your GitHub, and start searching in under a minute.
99+
100+
### Self-Hosted
101+
63102
```bash
64103
git clone https://github.com/OpenCodeIntel/opencodeintel.git
65104
cd opencodeintel
66105

67106
cp .env.example .env
68-
# Add your API keys
107+
# Add your OpenAI + Pinecone API keys
69108

70109
docker compose up -d
71110
```
72111

73-
Open http://localhost:3000. That's it.
112+
Open [localhost:3000](http://localhost:3000). Done.
74113

75114
<details>
76115
<summary><strong>Manual setup (without Docker)</strong></summary>
77116

78-
**Requirements:** Python 3.11+, Node.js 20+
117+
**Requirements:** Python 3.11+, Node.js 20+, Redis
79118

80119
```bash
81120
# Backend
82121
cd backend
83122
python -m venv venv && source venv/bin/activate
84123
pip install -r requirements.txt
85-
cp .env.example .env
86124
python main.py
87125

88126
# Frontend (new terminal)
@@ -95,7 +133,7 @@ npm install && npm run dev
95133
<details>
96134
<summary><strong>Connect to Claude Desktop (MCP)</strong></summary>
97135

98-
Add to your Claude Desktop config:
136+
Add to your Claude Desktop config (`~/Library/Application Support/Claude/claude_desktop_config.json`):
99137

100138
```json
101139
{
@@ -112,38 +150,89 @@ Add to your Claude Desktop config:
112150
}
113151
```
114152

115-
See [full MCP setup guide](./docs/mcp-setup.md).
153+
See [full MCP setup guide](./docs/mcp-setup.md)
116154

117155
</details>
118156

157+
---
158+
159+
## Why I Built This
160+
161+
I got tired of grep.
162+
163+
Every time I joined a new project or inherited a codebase, I spent hours just figuring out where things lived. The original authors were gone. The docs were outdated. And I was scared to change anything because I couldn't see what depended on what.
164+
165+
I wanted code search that actually understood what code does. Not pattern matching on text. Something that could answer "where do we handle user sessions?" without me already knowing the answer.
166+
167+
OpenCodeIntel is the tool I wish I had. It's open source because I think every developer deserves to understand their code, not just those at companies with dedicated platform teams.
168+
169+
---
170+
119171
## Architecture
120172

121-
```
173+
```text
122174
┌─────────────────────────────────────────┐
123-
│ Frontend (React)
175+
│ Frontend (React + Vite)
124176
└─────────────────┬───────────────────────┘
125177
126178
┌─────────────────▼───────────────────────┐
127179
│ Backend (FastAPI) │
180+
│ • Semantic indexing with OpenAI │
181+
│ • Dependency graph analysis │
182+
│ • Real-time WebSocket updates │
128183
└───────┬─────────┬─────────┬─────────────┘
129184
│ │ │
130185
┌────▼───┐ ┌───▼────┐ ┌──▼───┐
131186
│Pinecone│ │Supabase│ │Redis │
132-
│vectors │ │database│ │cache │
187+
│vectors │ │metadata│ │cache │
133188
└────────┘ └────────┘ └──────┘
134189
```
135190

136-
## Docs
191+
---
192+
193+
## Roadmap
194+
195+
- [x] Semantic code search
196+
- [x] GitHub OAuth integration
197+
- [x] Dependency graph visualization
198+
- [x] Impact analysis
199+
- [x] MCP server for Claude
200+
- [ ] VS Code extension
201+
- [ ] Team workspaces
202+
- [ ] Self-hosted Ollama support (no OpenAI required)
203+
- [ ] GitLab / Bitbucket support
137204

138-
- [Docker Quickstart](./docs/docker-quickstart.md) — Running in 5 minutes
139-
- [Deployment Guide](./docs/deployment.md) — Production setup
140-
- [MCP Integration](./docs/mcp-setup.md) — Claude Desktop setup
141-
- [Troubleshooting](./docs/docker-troubleshooting.md) — Common fixes
205+
Want to influence the roadmap? [Open an issue](https://github.com/OpenCodeIntel/opencodeintel/issues).
206+
207+
---
142208

143209
## Contributing
144210

145-
We'd love your help. See [CONTRIBUTING.md](./CONTRIBUTING.md).
211+
Found a bug? [Open an issue](https://github.com/OpenCodeIntel/opencodeintel/issues/new?template=bug_report.yml)
212+
213+
Have an idea? [Request a feature](https://github.com/OpenCodeIntel/opencodeintel/issues/new?template=feature_request.yml)
214+
215+
Want to contribute code? See [CONTRIBUTING.md](./CONTRIBUTING.md)
216+
217+
---
218+
219+
## Documentation
220+
221+
- [Docker Quickstart](./docs/docker-quickstart.md)
222+
- [Deployment Guide](./docs/deployment.md)
223+
- [MCP Integration](./docs/mcp-setup.md)
224+
- [Troubleshooting](./docs/docker-troubleshooting.md)
225+
226+
---
146227

147228
## License
148229

149230
[MIT](./LICENSE)
231+
232+
---
233+
234+
<p align="center">
235+
<a href="https://opencodeintel.com">Website</a>
236+
&nbsp;&nbsp;·&nbsp;&nbsp;
237+
<a href="https://github.com/OpenCodeIntel/opencodeintel">GitHub</a>
238+
</p>

docs/assets/OpenCodeIntel_Fav.png

268 KB
Loading

docs/assets/hero.png

914 KB
Loading

frontend/index.html

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,15 @@
22
<html lang="en">
33
<head>
44
<meta charset="UTF-8" />
5-
<link rel="icon" type="image/svg+xml" href="/vite.svg" />
5+
<link rel="icon" type="image/png" href="/favicon.png" />
6+
<link rel="apple-touch-icon" href="/favicon.png" />
67
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
8+
<meta name="description" content="Stop feeling lost in unfamiliar codebases. Semantic code search powered by AI." />
9+
<meta name="theme-color" content="#0a0a0f" />
710
<link rel="preconnect" href="https://fonts.googleapis.com">
811
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
912
<link href="https://fonts.googleapis.com/css2?family=Inter:wght@300;400;500;600;700&family=JetBrains+Mono:wght@400;500&display=swap" rel="stylesheet">
10-
<title>CodeIntel - MCP Codebase Intelligence</title>
13+
<title>OpenCodeIntel – Understand Any Codebase</title>
1114
</head>
1215
<body>
1316
<div id="root"></div>

frontend/public/favicon.png

268 KB
Loading

frontend/public/vite.svg

Lines changed: 0 additions & 1 deletion
This file was deleted.

frontend/src/components/dashboard/TopNav.tsx

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -42,11 +42,12 @@ export function TopNav({ onToggleSidebar, sidebarCollapsed, onOpenCommandPalette
4242
</button>
4343

4444
<Link to="/dashboard" className="flex items-center gap-3">
45-
<div className="w-8 h-8 rounded-lg bg-primary flex items-center justify-center">
46-
<span className="text-primary-foreground font-bold text-xs">OCI</span>
47-
</div>
45+
<img
46+
src="/favicon.png"
47+
alt="OpenCodeIntel"
48+
className="w-8 h-8 rounded-lg"
49+
/>
4850
<span className="font-semibold text-foreground hidden sm:block">OpenCodeIntel</span>
49-
<span className="text-xs text-muted-foreground hidden md:block">MCP Server</span>
5051
</Link>
5152
</div>
5253

frontend/src/components/landing/Navbar.tsx

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -35,9 +35,11 @@ export function Navbar({ minimal }: NavbarProps) {
3535
<div className="max-w-6xl mx-auto px-4 sm:px-6 py-4 flex items-center justify-between">
3636
{/* Logo */}
3737
<a href="/" className="flex items-center gap-2.5 group">
38-
<div className="w-8 h-8 rounded-lg bg-gradient-to-br from-accent to-blue-600 flex items-center justify-center shadow-lg shadow-accent/20">
39-
<span className="text-white font-bold text-xs">OCI</span>
40-
</div>
38+
<img
39+
src="/favicon.png"
40+
alt="OpenCodeIntel"
41+
className="w-8 h-8 rounded-lg"
42+
/>
4143
<span className="font-semibold text-foreground">OpenCodeIntel</span>
4244
</a>
4345

frontend/src/pages/Playground.tsx

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -98,9 +98,11 @@ export function Playground({ onSignupClick }: PlaygroundProps) {
9898
<nav className="border-b border-gray-100 bg-white/80 backdrop-blur-sm sticky top-0 z-50">
9999
<div className="max-w-6xl mx-auto px-6 h-14 flex items-center justify-between">
100100
<div className="flex items-center gap-2">
101-
<div className="w-7 h-7 rounded-lg bg-blue-600 flex items-center justify-center">
102-
<span className="text-white font-bold text-xs">CI</span>
103-
</div>
101+
<img
102+
src="/favicon.png"
103+
alt="OpenCodeIntel"
104+
className="w-7 h-7 rounded-lg"
105+
/>
104106
<span className="font-semibold text-gray-900">OpenCodeIntel</span>
105107
</div>
106108
<div className="flex items-center gap-3">

0 commit comments

Comments
 (0)