Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/informatter/fullstack-fastapi-rag-sample

Last synced: 3 days ago
JSON representation

Host: GitHub
URL: https://github.com/informatter/fullstack-fastapi-rag-sample
Owner: informatter
Created: 2024-03-08T11:25:00.000Z (11 months ago)
Default Branch: develop
Last Pushed: 2024-03-20T11:56:20.000Z (11 months ago)
Last Synced: 2024-11-28T11:08:35.791Z (2 months ago)
Language: Python
Size: 211 KB
Stars: 0
Watchers: 2
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

        [![Formatting with ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)

[![Type checking with pyright](https://microsoft.github.io/pyright/img/pyright_badge.svg)](https://microsoft.github.io/pyright/)

[![Security checking with bandit](https://img.shields.io/badge/security-bandit-yellow.svg)](https://github.com/PyCQA/bandit)

![Frontend](https://github.com/informatter/fullstack-fastapi-rag-sample/actions/workflows/frontend_ci_cd.yml/badge.svg?branch=develop)

![Backend](https://github.com/informatter/fullstack-fastapi-rag-sample/actions/workflows/backend_ci_cd.yml/badge.svg?branch=develop)

# 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](https://github.com/astral-sh/ruff)

    - data validation :  [pydantic](https://github.com/pydantic/pydantic)

    - static type checking :  [pydantic](https://github.com/microsoft/pyright)

    - logging: [structlog](https://github.com/hynek/structlog)

    - security: [bandit](https://github.com/openstack/bandit)

    - testing : [pytest](https://github.com/pytest-dev/pytest)

**frontend**

- Vue 3

- Typescript

- **tooling**

    - bundler: [vite](https://vitejs.dev/)

    - linting: [eslint](https://eslint.org/)

    - formatting: [prettier](https://prettier.io/)

    - testing: [vitest](https://vitest.dev/)

**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](https://github.com/informatter/fullstack-fastapi-rag-sample/blob/develop/backend/README.md)

[Frontend](https://github.com/informatter/fullstack-fastapi-rag-sample/blob/develop/frontend/README.md)