11# Sleek AI
22
3- A full-stack AI chat application featuring real-time messaging, file ingestion, and vector search capabilities. Built with modern web technologies for performance and scalability.
3+ ![ Sleek AI Preview ] ( ./assets/preview.webp )
44
5- ## Features
5+ [ ![ ci] ( https://github.com/sunjay-dev/sleek-ai/actions/workflows/docker-build-push.yaml/badge.svg )] ( https://github.com/sunjay-dev/sleek-ai/actions/workflows/docker-build-push.yaml )
6+ [ ![ License: MIT] ( https://img.shields.io/badge/License-MIT-yellow.svg )] ( https://opensource.org/licenses/MIT )
7+ [ ![ Last Commit] ( https://img.shields.io/github/last-commit/sunjay-dev/sleek-ai )] ( https://github.com/sunjay-dev/sleek-ai/commits/main )
8+
9+ A full-stack AI chat application featuring real-time messaging, file ingestion, and vector search capabilities. Optimized for speed, reliability, and seamless AI interactions.
610
11+ ## Features
712- ** AI Chat Interface** : Interactive chat with AI models.
813- ** File Ingestion** : Upload and process documents (PDF, Docx, TXT) for context-aware responses.
914- ** Vector Search** : Semantic search powered by Pinecone and Google Gemini embeddings.
@@ -13,7 +18,11 @@ A full-stack AI chat application featuring real-time messaging, file ingestion,
1318
1419## Tech Stack
1520
16-                   
21+                     
22+
23+ ## Architecture
24+
25+ ![ Architecture Diagram] ( ./assets/architecture_diagram.png )
1726
1827## Prerequisites
1928
@@ -38,11 +47,10 @@ A full-stack AI chat application featuring real-time messaging, file ingestion,
3847
39483. ** Environment Configuration**
4049
41- Copy the ` .env.example` files to ` .env` in ` backend` , ` frontend ` , and ` worker` directories and fill in your secrets.
50+ Copy the ` .env.example` files to ` .env` in ` backend` and ` worker` directories and fill in your secrets.
4251
4352 ` ` ` bash
4453 cp backend/.env.example backend/.env
45- cp frontend/.env.example frontend/.env
4654 cp worker/.env.example worker/.env
4755 ` ` `
4856
@@ -65,6 +73,15 @@ A full-stack AI chat application featuring real-time messaging, file ingestion,
6573 ` ` `
6674 This will start the specialized dev scripts defined in the root ` package.json` .
6775
76+ # # Project Structure
77+
78+ This is a monorepo containing:
79+
80+ - ** ` frontend/` ** : Vite-based React application with Tailwind CSS and Shadcn UI.
81+ - ** ` backend/` ** : Hono.js API server handling chat logic, authentication, and job dispatching.
82+ - ** ` worker/` ** : BullMQ-based background worker for processing file metadata and vector embeddings.
83+ - ** ` shared/` ** : Shared TypeScript types and utility functions used across packages.
84+
6885# # Contribution
6986
7087See [CONTRIBUTING.md](./CONTRIBUTING.md) for guidelines on how to contribute to this project.
0 commit comments