EduConnect / README.md
dtyago's picture
Updated proj structure
750b0f4
|
raw
history blame
2.53 kB
---
title: EduConnect
emoji: πŸ†
colorFrom: red
colorTo: pink
sdk: docker
pinned: false
license: apache-2.0
---
Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
```
EduConnect/
β”œβ”€β”€ app/
β”‚ β”œβ”€β”€ __init__.py # Initializes the FastAPI app and global configurations
β”‚ β”œβ”€β”€ main.py # Entry point for the FastAPI application, defining routes
β”‚ β”œβ”€β”€ dependencies.py # Dependency utilities for JWT token verification, etc.
β”‚ β”œβ”€β”€ api/
β”‚ β”‚ β”œβ”€β”€ __init__.py
β”‚ β”‚ β”œβ”€β”€ userlogin.py # Endpoint for user login functionality
β”‚ β”‚ β”œβ”€β”€ userlogout.py # Endpoint for user logout functionality
β”‚ β”‚ β”œβ”€β”€ userchat.py # Endpoint for chat functionality
β”‚ β”‚ └── userupload.py # Endpoint for file upload functionality
β”‚ β”œβ”€β”€ admin/
β”‚ β”‚ β”œβ”€β”€ __init__.py
β”‚ β”‚ β”œβ”€β”€ admin_functions.py # Contains server-side logic for admin tasks
β”‚ β”‚ └── templates/ # Jinja2 templates for admin UI
β”‚ β”‚ β”œβ”€β”€ admin_login.html # Template for admin login page
β”‚ β”‚ └── user_registration.html # Template for user registration page
β”‚ └── utils/
β”‚ β”œβ”€β”€ __init__.py
β”‚ β”œβ”€β”€ db.py # Centraized DB functions for ChromaDB collections, TinyDB
β”‚ β”œβ”€β”€ chat_rag.py # LLM chat function with RAG from vector DB
β”‚ β”œβ”€β”€ doc_ingest.py # Utility to ingest pdf documents into vector DB
β”‚ β”œβ”€β”€ jwt_utils.py # Utility for JWT tokens
β”‚ β”œβ”€β”€ download_model.py # Utility for downloading model from hugging face
β”‚ └── ec_image_utils.py # Integrates MTCNN and Facenet for login authentication
β”œβ”€β”€ static/
β”‚ β”œβ”€β”€ css/ # CSS for the administration portal
β”‚ β”œβ”€β”€ js/ # Javascripts if any for administration portal
β”‚ └── images/ # UI rendering images for administration page
β”œβ”€β”€ Dockerfile # Docker configuration for setting up the environment
β”œβ”€β”€ requirements.txt # Lists all Python library dependencies
β”œβ”€β”€ entrypoint.sh
└── .env # Environment variables for configuration settings
```