Patch

README.md

@@ -0,0 +1,78 @@
+# SearchlyAI
+
+SearchlyAI is a powerful Retrieve-Augmented Generation (RAG) search engine that allows users to ingest documents (PDF, TXT) and web pages, and then query them using natural language. It leverages Google's Gemini for embeddings and answer generation, and FAISS for efficient vector similarity search.
+
+## 🚀 Features
+
+-   **Multi-Source Ingestion**: Support for PDF documents, text files, and web pages.
+-   **Semantic Search**: Uses vector embeddings to understand the *meaning* behind your query, not just keyword matching.
+-   **RAG Architecture**: Retrieves relevant context and generates natural language answers using LLMs.
+-   **Session Management**: Keeps data isolated per session.
+-   **Efficient Vector Storage**: Uses FAISS for lighting-fast similarity search.
+
+## 🛠️ Tech Stack
+
+### Backend
+-   **Framework**: FastAPI
+-   **LLM & Embeddings**: Google Gemini (via LangChain/GenerativeAI)
+-   **Vector Store**: FAISS
+-   **Validation**: Pydantic
+
+### Frontend
+-   **Framework**: React (Vite)
+-   **Language**: TypeScript
+-   **Styling**: (Pending - to be built)
+
+## 📂 Project Structure
+
+```
+SearchlyAI/
+├── backend/            # FastAPI Backend
+│   ├── app/            # Application logic
+│   └── data/           # Local vector store data
+├── frontend/           # React Frontend (Vite)
+├── docker-compose.yml  # Docker orchestration
+└── README.md           # This file
+```
+
+## 🏎️ Getting Started
+
+### Prerequisites
+-   Docker & Docker Compose
+-   Node.js (for local frontend dev)
+-   Python 3.10+ (for local backend dev)
+-   Google Gemini API Key
+
+### Running with Docker
+
+1.  Set up your environment variables:
+    ```bash
+    cp backend/.env.example backend/.env
+    # Edit backend/.env and add your GEMINI_API_KEY
+    ```
+
+2.  Run the stack:
+    ```bash
+    docker-compose up --build
+    ```
+
+### Local Development
+
+**Backend:**
+```bash
+cd backend
+python -m venv venv
+source venv/bin/activate  # or venv\Scripts\activate on Windows
+pip install -r requirements.txt
+uvicorn main:app --reload
+```
+
+**Frontend:**
+```bash
+cd frontend
+npm install
+npm run dev
+```
+
+## 📄 License
+MIT

backend/README.md

@@ -1,14 +1,13 @@
-# RAG Search Engine Backend
+# SearchlyAI Backend
 
-This is the backend for a RAG (Retrieval-Augmented Generation) Search Engine built with FastAPI.
+This is the backend API for SearchlyAI, built with FastAPI.
 
 ## Structure
 - `app/api`: API route definitions
 - `app/core`: Core configuration and logging
 - `app/services`: Business logic (ingestion, chunking, embeddings, etc.)
 - `app/schemas`: Pydantic models
 - `app/utils`: Helper functions
-- `app/llm`: LLM abstractions (OpenAI, Gemini)
 
 ## Setup
 
@@ -24,7 +23,7 @@ This is the backend for a RAG (Retrieval-Augmented Generation) Search Engine bui
    ```
 
 3. Configure environment variables:
-   Copy `.env.example` to `.env` and fill in your API keys.
+   Copy `.env.example` to `.env` and fill in your API keys (Gemini API Key is required).
 
 4. Run the server:
    ```bash

backend/app/core/config.py

@@ -4,7 +4,7 @@
 
 class Settings(BaseSettings):
     # App
-    APP_NAME: str = "SemanticSearch AI"
+    APP_NAME: str = "SearchlyAI"
     ENV: str = "development"
 
     # Gemini

backend/main.py

@@ -11,7 +11,7 @@
 setup_logging()
 
 app = FastAPI(
-    title="SemanticSearch AI",
+    title="SearchlyAI",
     description="AI-powered semantic search engine using RAG",
     version="1.0.0"
 )

frontend/.gitignore

@@ -0,0 +1,24 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+pnpm-debug.log*
+lerna-debug.log*
+
+node_modules
+dist
+dist-ssr
+*.local
+
+# Editor directories and files
+.vscode/*
+!.vscode/extensions.json
+.idea
+.DS_Store
+*.suo
+*.ntvs*
+*.njsproj
+*.sln
+*.sw?

frontend/README.md

@@ -0,0 +1,73 @@
+# React + TypeScript + Vite
+
+This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules.
+
+Currently, two official plugins are available:
+
+- [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react) uses [Babel](https://babeljs.io/) (or [oxc](https://oxc.rs) when used in [rolldown-vite](https://vite.dev/guide/rolldown)) for Fast Refresh
+- [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react-swc) uses [SWC](https://swc.rs/) for Fast Refresh
+
+## React Compiler
+
+The React Compiler is not enabled on this template because of its impact on dev & build performances. To add it, see [this documentation](https://react.dev/learn/react-compiler/installation).
+
+## Expanding the ESLint configuration
+
+If you are developing a production application, we recommend updating the configuration to enable type-aware lint rules:
+
+```js
+export default defineConfig([
+  globalIgnores(['dist']),
+  {
+    files: ['**/*.{ts,tsx}'],
+    extends: [
+      // Other configs...
+
+      // Remove tseslint.configs.recommended and replace with this
+      tseslint.configs.recommendedTypeChecked,
+      // Alternatively, use this for stricter rules
+      tseslint.configs.strictTypeChecked,
+      // Optionally, add this for stylistic rules
+      tseslint.configs.stylisticTypeChecked,
+
+      // Other configs...
+    ],
+    languageOptions: {
+      parserOptions: {
+        project: ['./tsconfig.node.json', './tsconfig.app.json'],
+        tsconfigRootDir: import.meta.dirname,
+      },
+      // other options...
+    },
+  },
+])
+```
+
+You can also install [eslint-plugin-react-x](https://github.com/Rel1cx/eslint-react/tree/main/packages/plugins/eslint-plugin-react-x) and [eslint-plugin-react-dom](https://github.com/Rel1cx/eslint-react/tree/main/packages/plugins/eslint-plugin-react-dom) for React-specific lint rules:
+
+```js
+// eslint.config.js
+import reactX from 'eslint-plugin-react-x'
+import reactDom from 'eslint-plugin-react-dom'
+
+export default defineConfig([
+  globalIgnores(['dist']),
+  {
+    files: ['**/*.{ts,tsx}'],
+    extends: [
+      // Other configs...
+      // Enable lint rules for React
+      reactX.configs['recommended-typescript'],
+      // Enable lint rules for React DOM
+      reactDom.configs.recommended,
+    ],
+    languageOptions: {
+      parserOptions: {
+        project: ['./tsconfig.node.json', './tsconfig.app.json'],
+        tsconfigRootDir: import.meta.dirname,
+      },
+      // other options...
+    },
+  },
+])
+```

frontend/eslint.config.js

@@ -0,0 +1,23 @@
+import js from '@eslint/js'
+import globals from 'globals'
+import reactHooks from 'eslint-plugin-react-hooks'
+import reactRefresh from 'eslint-plugin-react-refresh'
+import tseslint from 'typescript-eslint'
+import { defineConfig, globalIgnores } from 'eslint/config'
+
+export default defineConfig([
+  globalIgnores(['dist']),
+  {
+    files: ['**/*.{ts,tsx}'],
+    extends: [
+      js.configs.recommended,
+      tseslint.configs.recommended,
+      reactHooks.configs.flat.recommended,
+      reactRefresh.configs.vite,
+    ],
+    languageOptions: {
+      ecmaVersion: 2020,
+      globals: globals.browser,
+    },
+  },
+])

frontend/index.html

@@ -0,0 +1,13 @@
+<!doctype html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8" />
+    <link rel="icon" type="image/svg+xml" href="/vite.svg" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <title>frontend</title>
+  </head>
+  <body>
+    <div id="root"></div>
+    <script type="module" src="/src/main.tsx"></script>
+  </body>
+</html>

frontend/package.json

@@ -0,0 +1,30 @@
+{
+  "name": "frontend",
+  "private": true,
+  "version": "0.0.0",
+  "type": "module",
+  "scripts": {
+    "dev": "vite",
+    "build": "tsc -b && vite build",
+    "lint": "eslint .",
+    "preview": "vite preview"
+  },
+  "dependencies": {
+    "react": "^19.2.0",
+    "react-dom": "^19.2.0"
+  },
+  "devDependencies": {
+    "@eslint/js": "^9.39.1",
+    "@types/node": "^24.10.1",
+    "@types/react": "^19.2.5",
+    "@types/react-dom": "^19.2.3",
+    "@vitejs/plugin-react": "^5.1.1",
+    "eslint": "^9.39.1",
+    "eslint-plugin-react-hooks": "^7.0.1",
+    "eslint-plugin-react-refresh": "^0.4.24",
+    "globals": "^16.5.0",
+    "typescript": "~5.9.3",
+    "typescript-eslint": "^8.46.4",
+    "vite": "^7.2.4"
+  }
+}

frontend/src/App.css

@@ -0,0 +1,42 @@
+#root {
+  max-width: 1280px;
+  margin: 0 auto;
+  padding: 2rem;
+  text-align: center;
+}
+
+.logo {
+  height: 6em;
+  padding: 1.5em;
+  will-change: filter;
+  transition: filter 300ms;
+}
+.logo:hover {
+  filter: drop-shadow(0 0 2em #646cffaa);
+}
+.logo.react:hover {
+  filter: drop-shadow(0 0 2em #61dafbaa);
+}
+
+@keyframes logo-spin {
+  from {
+    transform: rotate(0deg);
+  }
+  to {
+    transform: rotate(360deg);
+  }
+}
+
+@media (prefers-reduced-motion: no-preference) {
+  a:nth-of-type(2) .logo {
+    animation: logo-spin infinite 20s linear;
+  }
+}
+
+.card {
+  padding: 2em;
+}
+
+.read-the-docs {
+  color: #888;
+}

frontend/src/App.tsx

@@ -0,0 +1,35 @@
+import { useState } from 'react'
+import reactLogo from './assets/react.svg'
+import viteLogo from '/vite.svg'
+import './App.css'
+
+function App() {
+  const [count, setCount] = useState(0)
+
+  return (
+    <>
+      <div>
+        <a href="https://vite.dev" target="_blank">
+          <img src={viteLogo} className="logo" alt="Vite logo" />
+        </a>
+        <a href="https://react.dev" target="_blank">
+          <img src={reactLogo} className="logo react" alt="React logo" />
+        </a>
+      </div>
+      <h1>Vite + React</h1>
+      <div className="card">
+        <button onClick={() => setCount((count) => count + 1)}>
+          count is {count}
+        </button>
+        <p>
+          Edit <code>src/App.tsx</code> and save to test HMR
+        </p>
+      </div>
+      <p className="read-the-docs">
+        Click on the Vite and React logos to learn more
+      </p>
+    </>
+  )
+}
+
+export default App