https://github.com/huerte/academiqly
A web-based system designed to provide students and teachers with real-time calculation of overall subject grades.
https://github.com/huerte/academiqly
academic-project authentication bootstrap5 django django-project educational-software python school-project vanilla web-based-system website
Last synced: 2 months ago
JSON representation
A web-based system designed to provide students and teachers with real-time calculation of overall subject grades.
- Host: GitHub
- URL: https://github.com/huerte/academiqly
- Owner: Huerte
- License: mit
- Created: 2025-09-01T12:08:16.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2026-03-19T06:11:28.000Z (3 months ago)
- Last Synced: 2026-03-19T23:20:12.141Z (3 months ago)
- Topics: academic-project, authentication, bootstrap5, django, django-project, educational-software, python, school-project, vanilla, web-based-system, website
- Language: HTML
- Homepage:
- Size: 7.99 MB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# AcademiQly
[](#)
[](#)
[](#)
[](#)
**A web-based system designed to provide students and teachers with real-time calculation of overall subject grades.**
---
## Table of Contents
- [Demo](#demo)
- [Features](#features)
- [Installation Guidance](#installation-guide)
- [Usage](#usage)
- [Project Structure](#project-structure)
- [Configuration](#configuration)
- [Contributing](#contributing)
- [License](#license)
---
## Demo
> Visual overview of the AcademiQly platform.
### Public Intro Page
### Authentication
### Teacher Dashboard
### Student Dashboard
_This project runs as a web environment. See [Usage](#usage) for expected interactions._
---
## Features
AcademiQly provides a web-based dashboard designed for real-time subject grade calculation.
Built to be efficient, accessible, and user-friendly for both teachers and students.
- **Real-Time Calculation:** Provides an overall view of student grades dynamically.
- **Role-Based Access:** Dashboards tailored specifically to teachers and students.
- **Public Intro Page:** A welcoming public-facing first page that serves as an introduction to the platform for new users.
- **Database Integration:** Securely maintains academic records via SQLite/PostgreSQL.
---
## Installation Guide
Follow these steps to install AcademiQly locally.
### Prerequisites
- **Python 3.10+**
- **pip (Python Package Manager)**
- **PostgreSQL / SQLite**
---
### Step 1: Get the Code
```bash
git clone https://github.com/Huerte/AcademiQly.git
cd AcademiQly
```
---
### Step 2: Install Dependencies
```bash
pip install -r src/requirements.txt
```
---
### Step 3: Database & Migration
```bash
cd src
python manage.py makemigrations
python manage.py migrate
```
---
### Step 4: Run the Server
```bash
python manage.py runserver
```
---
## Usage
1. Open your browser and navigate to `http://127.0.0.1:8000/`.
2. Login as a Teacher or Student.
3. Use the dashboard to input grades and view automatically calculated overall subject grades.
4. Export or generate necessary academic reports.
---
## Project Structure
```
AcademiQly/
│
├── src/ # Core Django Logic
│ ├── core/ # Base logic and settings
│ ├── main/ # Main application and views
│ ├── dashboard/ # Dashboard specific application
│ ├── user/ # User authentication & role management
│ ├── room/ # Subject or classroom application
│ ├── static/ # Static resources (CSS, JS, Images)
│ ├── templates/ # HTML Templates
│ ├── manage.py # Django startup script
│ └── requirements.txt # Project Python dependencies
└── README.md
```
---
## Configuration
Edit the environment configuration file using the provided `.env` format:
```bash
AcademiQly/.env
```
| Key | Type | Default | Description |
|-----|------|---------|-------------|
| `SECRET_KEY` | `string` | `-` | Django secret key for cryptographic signing. |
| `DEBUG` | `boolean` | `True` | Toggles development mode on/off. |
| `DATABASE_URL` | `string` | `sqlite:///db.sqlite3` | Connection URI for your database. |
---
## Contributing
Contributions are welcome and appreciated!
1. Fork the Project
2. Create a Feature Branch (`git checkout -b feature/AmazingFeature`)
3. Commit Changes (`git commit -m 'Add AmazingFeature'`)
4. Push to Branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request
---
## License
Distributed under the **MIT** License. See [`LICENSE`](LICENSE) for details.
---
© 2026 [Huerte](https://github.com/Huerte). All Rights Reserved.