EduConnect / README.md
dtyago's picture
restructure project
7832703
|
raw
history blame
2.21 kB
metadata
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.
β”‚   β”œβ”€β”€ models.py                    # Database models for ORM
β”‚   β”œβ”€β”€ schemas.py                   # Pydantic schemas for request and response validation
β”‚   β”œβ”€β”€ crud.py                      # CRUD operations interfacing with the database
β”‚   β”œβ”€β”€ api/
β”‚   β”‚   β”œβ”€β”€ __init__.py
β”‚   β”‚   β”œβ”€β”€ userlogin.py             # Endpoint for user login functionality
β”‚   β”‚   β”œβ”€β”€ userlogout.py            # Endpoint for user logout functionality
β”‚   β”‚   β”œβ”€β”€ userchat.py              # Endpoint for chat functionality
β”‚   β”‚   └── userhistory.py           # Endpoint for loading chat history
β”‚   β”œβ”€β”€ 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
β”‚       β”œβ”€β”€ authentication.py        # Integrates MTCNN and Facenet for login authentication
β”‚       └── database.py              # ChromaDB integration and database utilities
β”œβ”€β”€ static/
β”‚   β”œβ”€β”€ css/
β”‚   β”œβ”€β”€ js/
β”‚   └── images/
β”œβ”€β”€ Dockerfile                       # Docker configuration for setting up the environment
β”œβ”€β”€ requirements.txt                 # Lists all Python library dependencies
└── .env                             # Environment variables for configuration settings