🚀 ChatPilot

ChatPilot is a modular AI-powered backend built using FastAPI and LangChain, designed to serve as a scalable foundation for intelligent chat applications.

---

📌 Features

• ⚡ FastAPI-based high-performance API layer
• 🧠 AI layer powered by LangChain
• 🔌 Modular architecture (easy to extend)
• 📦 Clean project structure for scalability
• 🧪 Ready for testing and production evolution

---

🏗️ Project Structure

ChatPilot/
│
├── app/
│   ├── ai_layer/          # AI models, chatbot logic, and tools
│   │   ├── chatbot.py
│   │   ├── model.py
│   │   └── tools.py
│   │
│   ├── api/               # API routes, schemas, and helpers
│   │   ├── chat.py
│   │   ├── helper.py
│   │   └── schemas.py
│   │
│   ├── utils/             # Configuration and utility functions
│   │   └── config.py
│   │
│   ├── main.py            # FastAPI application entry point
│   └── version.py         # Application version
│
├── frontend.py            # Frontend / client interface
├── CHANGELOG.md           # Project release history
├── README.md              # Project documentation
├── pyproject.toml         # Project metadata and dependencies
├── requirements.txt       # Python dependencies
├── uv.lock                # Dependency lock file
└── .env                   # Environment variables

Note: Create a .env file manually in the project root and add the required environment variables:

GEMINI_API_KEY=your_api_key_here

---

⚙️ Installation

1. Clone the repository

git clone git@github.com:Abdullah-kwl/ChatPilot.git
cd ChatPilot

2. Create virtual environment

python -m venv venv
venv\Scripts\activate   # Windows
# source venv/bin/activate  # Linux/Mac

3. Install dependencies

Using uv (Recommended)

uv sync

Using pip

pip install -r requirements.txt

---

▶️ Running the Application

uv run uvicorn app.main:app 
uv run streamlit run frontend.py

Backend will be available at:

http://127.0.0.1:8000

Frontend will be available at:

http://localhost:8501

---

📡 API Documentation

FastAPI provides built-in API documentation:

• Swagger UI → http://127.0.0.1:8000/docs
• ReDoc → http://127.0.0.1:8000/redoc

🖥️ Frontend Interface

Streamlit frontend can be accessed at:

• Streamlit App → http://localhost:8501

---

🧠 AI Layer

The ai_layer module handles:

• LangChain Agents
• LLM integrations

---

📦 Versioning

Version is managed in:

app/version.py

---

📜 Changelog

All changes are documented in:

CHANGELOG.md

---

🤝 Contributing

Contributions are welcome!

1. Fork the repo
2. Create a feature branch
3. Commit changes
4. Push and open a PR

---

📄 License

This project is licensed under the MIT License.

---

👨‍💻 Author

Abdullah GitHub: https://github.com/Abdullah-kwl