DocsGPT ๐
Your Intelligent Documentation Assistant
DocsGPT is a cutting-edge documentation search and exploration tool that combines the power of LangChain and GPT technology to provide precise, context-aware answers from your documentation.
โจ Features
- ๐ Intelligent Search: Natural language processing for intuitive documentation queries
- ๐ค LangChain Integration: Advanced query processing and context understanding
- ๐ Smart Content Processing: Efficient document aggregation and vector embeddings
- ๐ฏ Precise Results: GPT-enhanced result refinement and summarization
- ๐ป Modern UI: Responsive React-based interface with smooth animations
- ๐ Cross-Platform: Works with various documentation formats and sources
๐๏ธ Architecture
DocsGPT utilizes a sophisticated architecture consisting of:
User Interface Layer
- React + Tailwind CSS frontend
- Framer Motion animations
- Responsive design
API Layer
- FastAPI backend
- Request handling and authentication
- API endpoint management
Processing Layer
- LangChain Orchestrator
- Document processing pipeline
- Vector embedding generation
Storage Layer
- Vector database integration
- Efficient document indexing
- Fast retrieval system
๐ Getting Started
Prerequisites
- Node.js (v14 or higher)
- Python 3.8+
- pip
Installation
Clone the repository:
git clone https://github.com/codewitdark-git/DocsGPT.git
cd DocsGPT
Install frontend dependencies:
cd frontend
npm install
Install backend dependencies:
cd ../backend
pip install -r requirements.txt
Start the development servers:
# Frontend (in frontend directory)
npm run dev
# Backend (in backend directory)
python main.py
๐ ๏ธ Development
Frontend Structure
frontend/
โโโ src/
โ โโโ components/ # React components
โ โโโ assets/ # Images and static files
โ โโโ styles/ # CSS and styling
โ โโโ App.jsx # Main application component
Key Technologies
Frontend:
- React
- Tailwind CSS
- Framer Motion
- React Router
Backend:
- FastAPI
- LangChain
- Vector Embeddings
- GPT Integration
๐ค Contributing
We welcome contributions! Please follow these steps:
- Fork the repository
- Create a feature branch
- Commit your changes
- Push to the branch
- Submit a pull request
๐ซ Get in Touch
๐ License
This project is licensed under the MIT License - see the LICENSE file for details.
Built with โค๏ธ by the Dark Coder team