Academic Hub

Check the last release here!

The shown version was updated on 2025-01-13 So it may not be the latest version...

Features

• Comprehensive Data Management: Handle student records, course information, faculty details, and more.
• Real-time Updates: Utilize PLpgSQL real-time capabilities for instant data synchronization.
• Cross-platform Compatibility: Access the system via web browsers or as a desktop application.
• Scalable Architecture: Designed to handle large volumes of data efficiently.
• User-friendly Interface: Intuitive design using DaisyUI for enhanced user experience.
• Secure Authentication: Implement role-based access control for data protection.
• Reporting and Analytics: Generate insightful reports on various academic metrics.

Tech Stack

• Backend:
  • FastAPI for backend development
  • PostgreSQL for robust data storage
• Frontend:
  • SvelteKit for efficient web development
  • DaisyUI for responsive and attractive UI components
• Desktop Application:
  • Tauri for cross-platform desktop development

Installation

Docker Installation (Recommended)

1. Clone the repository:

git clone https://github.com/Yrrrrrf/academic-hub.git
cd academic-hub

2. Create a .env file in the project root with the following content:

# * db credentials
DB_NAME=a_hub
DB_OWNER_ADMIN=a_hub_admin
DB_OWNER_PWORD=password
DB_HOST=localhost

3. Build and start the Docker containers:

docker-compose up --build

Local Installation

For step-by-step instructions on how to set up the project locally without Docker, please refer to our Local Installation Guide.

Usage

• Access Web interface: http://localhost:5173
• Check API docs: http://localhost:8000/docs

Database Schema

Our database schema is designed to efficiently manage academic data. Including the separation in some schemas that help to organize the data in a more structured way.

This separation allows for better organization and management of data.

License

This project is licensed under the MIT License - see the LICENSE file for details.