📚 CodeIndex — Web Application

Intelligent documentation hub for junior developers and new recruits; search and explore codebase functions using semantic vector search.

Built with Astro and React, this web application is the user-facing layer of the CodeIndex platform. It allows developers to search across large codebases using natural language queries, powered by a vector database backend.

---

🧩 Part of the CodeIndex Ecosystem

Component	Tech	Role
Web App ← you are here	Astro + React	Displays documentation, handles search
Desktop App	C# WPF	Extracts source code
API	Node / Python (TBD)	Manages vector storage, tokenisation and search queries

---

✨ Features

• 🔍 Semantic Search — Find functions by meaning, not just exact name matches
• 📖 Function Documentation View — Auto-generated documentation cards per function
• 🏢 Multi-project Support — Navigate documentation across multiple codebases (Planned)
• ⚡ Fast Navigation — Static-first architecture via Astro for near-instant page loads
• 🧠 Vector-powered Results — Results ranked by semantic relevance via the API layer

---

🛠️ Tech Stack

• Astro — Static site framework handling routing and SSG/SSR
• React — Interactive UI components (search bar, results, doc viewer)
• REST API / Vector DB — Connected to the CodeIndex API for search queries

---

🚀 Getting Started

Prerequisites

• Node.js >=18.x
• npm or pnpm
• CodeIndex API running locally or accessible via URL

Installation

git clone https://github.com/your-org/devdocs-hub-webapp.git
cd devdocs-hub-webapp
npm install

Environment Variables

Create a .env file in the root:

PUBLIC_API_URL=http://localhost:3000

Running Locally

npm run dev

Due to time limitations the project will not be publicly released

Build for Production

npm run build
npm run preview

---

📁 Project Structure

/
├── public/             # Static assets
├── src/
│   ├── components/     # React components (SearchBar, DocCard, ResultsList...)
│   ├── layouts/        # Astro page layouts
│   ├── pages/          # Astro file-based routes
│   └── lib/            # API client, utilities
├── astro.config.mjs
└── package.json

---

🔗 Related Repositories

• CodeIndex-App — C# WPF Desktop App (code extraction)

---

📄 Licence

This project is part of a university dissertation. All rights reserved.

If it wasn't obvious this file is AI generated by Claude Code using sonnet 4.6 and manually fact checked to ensure accuracy.