Skip to content

Commit 80f082d

Browse files
committed
fix
1 parent 4cb75b2 commit 80f082d

18 files changed

Lines changed: 506 additions & 490 deletions

β€ŽREADME.mdβ€Ž

Lines changed: 10 additions & 111 deletions
Original file line numberDiff line numberDiff line change
@@ -1,120 +1,19 @@
1-
# πŸš€ Explorar.dev
1+
# Explorar.dev
22

3-
A standalone [Next.js 16](https://nextjs.org/) application for exploring and learning from arbitrary software source code with an interactive, VS Code-like interface. Perfect for studying the Linux kernel, Python CPython, glibc, LLVM, and any GitHub repository.
3+
Explore codebases with an interactive, VS Code-like interface.
44

5-
🌐 **Live Site**: [explorar.dev](https://explorar.dev)
6-
πŸ”“ **GitHub**: [pkill37/explorar.dev](https://github.com/pkill37/explorar.dev)
5+
Open-source curated repos (Linux, LLVM, glibc, XNU, etc) are pre-built for instant and offline access.
76

8-
## 🎯 Live Examples
7+
**[explorar.dev](https://explorar.dev)** Β· [GitHub](https://github.com/pkill37/explorar.dev) Β· [Discord](https://discord.gg/fuXYz44tSs)
98

10-
Explore these popular repositories instantly:
11-
12-
| Repository | Description | Live Demo |
13-
| ------------------- | --------------------------------- | ------------------------------------------------------------------------ |
14-
| **🐧 Linux Kernel** | Core operating system kernel | [explorar.dev/torvalds/linux](https://explorar.dev/torvalds/linux) |
15-
| **🐍 CPython** | Python interpreter implementation | [explorar.dev/python/cpython](https://explorar.dev/python/cpython) |
16-
| **πŸ”§ LLVM** | Compiler infrastructure project | [explorar.dev/llvm/llvm-project](https://explorar.dev/llvm/llvm-project) |
17-
| **πŸ“š glibc** | GNU C Library implementation | [explorar.dev/bminor/glibc](https://explorar.dev/bminor/glibc) |
18-
19-
> πŸ’‘ **Tip**: Curated repositories are pre-downloaded at build time β€” exploration is instant with no API calls needed!
20-
21-
## ✨ Features
22-
23-
- πŸ“ **Interactive File Browser**: Navigate any software source tree with VS Code-like interface
24-
- πŸ’» **Monaco Code Editor**: Full-featured editor with syntax highlighting for 100+ languages
25-
- πŸ“š **Guided Learning**: Chapter-based learning paths for curated repositories
26-
- πŸ—‚οΈ **Data Structures View**: Browse and explore kernel data structures and APIs
27-
- ⚑ **Static & Fast**: Curated repos are pre-built; no server needed
28-
- πŸ’Ύ **Local Storage**: IndexedDB-based persistent storage with offline access
29-
- 🎯 **Zero Setup**: No installation required β€” works entirely in your browser
30-
31-
## πŸš€ Getting Started
32-
33-
### 🌐 Using the Live Site
34-
35-
Simply visit [explorar.dev](https://explorar.dev) and click any of the pre-configured repositories (Linux, Python, LLVM, glibc).
36-
37-
### πŸ› οΈ Local Development
9+
## Development
3810

3911
```bash
4012
npm install
41-
npm run dev
42-
```
43-
44-
Opens at http://localhost:3000. The `predev` script automatically downloads the CPython repository for local testing.
45-
46-
**See [DEVELOPMENT.md](./DEVELOPMENT.md) for complete development instructions.**
47-
48-
## πŸ“ Project Structure
49-
50-
```
51-
explorar.dev/
52-
β”œβ”€β”€ src/ # Frontend (Next.js)
53-
β”‚ β”œβ”€β”€ app/
54-
β”‚ β”‚ β”œβ”€β”€ [owner]/[repo]/ # Dynamic repository routes
55-
β”‚ β”‚ β”œβ”€β”€ layout.tsx # Root layout with metadata
56-
β”‚ β”‚ └── page.tsx # Home page
57-
β”‚ β”œβ”€β”€ components/
58-
β”‚ β”‚ β”œβ”€β”€ KernelExplorer.tsx # Main repository explorer
59-
β”‚ β”‚ β”œβ”€β”€ FileTree.tsx # File tree navigation
60-
β”‚ β”‚ β”œβ”€β”€ CodeEditorContainer.tsx # Editor with tabs
61-
β”‚ β”‚ β”œβ”€β”€ MonacoCodeEditor.tsx # Monaco editor wrapper
62-
β”‚ β”‚ β”œβ”€β”€ GuidePanel.tsx # Learning guides
63-
β”‚ β”‚ └── ... # Other UI components
64-
β”‚ β”œβ”€β”€ contexts/
65-
β”‚ β”‚ └── RepositoryContext.tsx # Repository state management
66-
β”‚ β”œβ”€β”€ lib/
67-
β”‚ β”‚ β”œβ”€β”€ repo-storage.ts # IndexedDB storage
68-
β”‚ β”‚ β”œβ”€β”€ github-archive.ts # Repository downloading
69-
β”‚ β”‚ β”œβ”€β”€ github-api.ts # GitHub API integration
70-
β”‚ β”‚ β”œβ”€β”€ repo-static.ts # Static file serving
71-
β”‚ β”‚ └── ... # Other utilities
72-
β”‚ └── types/
73-
β”‚ └── index.ts # TypeScript type definitions
74-
β”œβ”€β”€ docs/ # Markdown guides for curated repos
75-
β”œβ”€β”€ public/
76-
β”‚ └── repos/ # Pre-downloaded curated repos (build artifact)
77-
└── scripts/
78-
└── download-repos.ts # Build-time repo downloader
13+
npm run dev # starts at localhost:3000, downloads CPython automatically
14+
npm run build # static export to out/
15+
npm run lint # tsc + eslint + prettier + depcheck
16+
npm test # Playwright tests (requires built output)
7917
```
8018

81-
## πŸ› οΈ Technologies
82-
83-
- **[Next.js 16](https://nextjs.org/)**: React framework with App Router (static export)
84-
- **[React 19](https://react.dev/)**: Latest React with concurrent features
85-
- **[Monaco Editor](https://microsoft.github.io/monaco-editor/)**: VS Code editor component
86-
- **[TypeScript](https://www.typescriptlang.org/)**: Full type safety
87-
- **[IndexedDB](https://developer.mozilla.org/en-US/docs/Web/API/IndexedDB_API)**: Browser database for persistent storage
88-
- **[JSZip](https://stuk.github.io/jszip/)**: Client-side zip file handling
89-
90-
## πŸ’Ύ Storage & Download System
91-
92-
### Curated Repositories (Static)
93-
94-
Pre-downloaded at build time via `scripts/download-repos.ts`. Files are served from `/public/repos/` β€” no API calls required, full offline support.
95-
96-
### Arbitrary Repositories (Dynamic)
97-
98-
User-entered GitHub repositories are downloaded on-demand into IndexedDB. Files are lazy-loaded when opened. Requires GitHub API access (60 req/hr unauthenticated).
99-
100-
## πŸ“š Documentation
101-
102-
- **[DEVELOPMENT.md](./DEVELOPMENT.md)** - Complete development guide
103-
- **[CLAUDE.md](./CLAUDE.md)** - Architecture and codebase guide for Claude Code
104-
105-
## 🀝 Contributing
106-
107-
Contributions and feedback are welcome!
108-
109-
## πŸ“„ License
110-
111-
Private project.
112-
113-
## πŸ”— Links
114-
115-
- 🌐 **Website**: [explorar.dev](https://explorar.dev)
116-
- πŸ”“ **GitHub**: [github.com/pkill37/explorar.dev](https://github.com/pkill37/explorar.dev)
117-
- πŸ’¬ **Discord**: [discord.gg/fuXYz44tSs](https://discord.gg/fuXYz44tSs)
118-
- πŸ“± **Telegram**: [t.me/explorardev](https://t.me/explorardev)
119-
- 🧠 **BrainSpeed.ai**: [AI-powered development tools](https://brainspeed.ai)
120-
- πŸ”„ **Reverser.dev**: [Reverse engineering platform](https://reverser.dev)
19+
See [CLAUDE.md](./CLAUDE.md) for architecture details.

0 commit comments

Comments
Β (0)