README.md

Sample Retrieval Augmented Generation (RAG) Full Stack Application 🤖 🦙

⚠️ Currently in the process of getting built 🛠️

This repo will be a full stack application which uses RAG for an AI agent to have domain specific knowledge. It currently uses the OpenAI API, but the goal is to have the functionality to swap it for open source models which can be self hosted.

Tech stack:

backend

• Python 🐍 3.11.7

• FastAPI ⚡

• Llama Index 🦙

• tooling

  • auto formatting and linting : Ruff
  • data validation : pydantic
  • static type checking : pydantic
  • logging: structlog
  • security: bandit
  • testing : pytest

frontend

• Vue 3
• Typescript
• tooling
  • bundler: vite
  • linting: eslint
  • formatting: prettier
  • testing: vitest

Infrastructure

• AWS is currently the cloud provider
• GitHub Actions is currently being used for building the CI/CD pipeline.
• Docker is currently being used for containarizing the application
• Auth0 is currently being used for authentication (in the frontend atm)
• Kubernetes will be used to orchestrate the containers
• Terraform will be used for infrastructure provisioning

Usage

Backend

Frontend