eddgachi/sme-doc-generator-llm
Domaine:
socioeconomicType de record:
software
Créateur:
edd
Hôte:
User selects a document type (quote, LPO, invoice, contract) and enters a few details; LLM drafts a polished, Kenya‑aware template they can download.
# SME Document Generator (sme-doc-generator-llm)
_A full-stack AI-powered document generation tool tailored for African SMEs._
---
## Table of Contents
1. Overview
2. Features
3. Demo & Screenshots
- GenerateDocView
- TemplateManagementView
- ModelSettingsView
- DocHistoryView
- ApiDocsView
4. Getting Started
- Prerequisites
- Installation
- Running Locally
5. Configuration
6. Project Structure
7. Technical Stack
8. API Endpoints
9. Contributing
10. License
---
## Overview
This repository implements **SME Document Generator**, a cloud-based application that leverages modern full-stack technologies and AI/LLM integrations to generate business documents (Quotes, Invoices, LPOs, Contracts) on demand. Users can select a document type, fill out dynamic forms, and receive a fully formatted document ready for download.
Key goals:
- Demonstrate full-stack proficiency with Python (FastAPI) and Vue.js.
- Showcase LLM integration using OpenAI’s ChatGPT or compatible free-tier models.
- Provide a responsive, user-friendly interface styled with Bootstrap/Tailwind.
- Illustrate best practices in API design, environment configuration, and Docker-based deployment.
---
## Features
- **Dynamic Document Generation**: Select from multiple document types and fill in context-specific fields.
- **Live Preview**: Instant preview of generated content before download.
- **Download Options**: Export generated documents in PDF/DOCX formats.
- **Template Management**: Admin view to create, edit, activate/deactivate prompt templates.
- **LLM Settings**: Adjust model parameters (model name, temperature, max tokens) and test the connection.
- **History Tracking**: View, filter, and re-download past generation requests.
- **Interactive API Docs**: Embedded Swagger UI for exploring backend endpoints.
- **Docker-Compose Setup**: One-command spin-up for development with FastAPI, Vue.js, and PostgreSQL.
---
## Demo & Screenshots
> _Add your screenshots here to showcase the UI/UX of each …