AcademiQly

A web-based system designed to provide students and teachers with real-time calculation of overall subject grades.

Report a Bug · Request a Feature

---

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.

---

Table of Contents

• Installation Guide
• What It Does
• Demo
• How It Works
• Usage
• Configuration
• Contributing
• Contributors
• License

---

Installation Guide

Follow these steps to install AcademiQly locally.

Prerequisites

What you need	Where to get it
Python 3.10+	python.org
Git	Already on your machine
PostgreSQL / SQLite	Database environment

Build from Source

Steps:

1. Clone the repository:

   git clone https://github.com/Huerte/AcademiQly.git
   cd AcademiQly

2. Install Dependencies:

   pip install -r src/requirements.txt

3. Database & Migration:

   cd src
   python manage.py makemigrations
   python manage.py migrate

4. Run the Server:

   python manage.py runserver

---

What It Does

Feature	What it means
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.

---

Demo

Visual overview of the AcademiQly platform.

Authentication

Teacher Dashboard

Student Dashboard

---

How It Works

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

---

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.

---

Configuration

Edit the environment configuration file using the provided .env format:

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. Here is how to go from zero to a submitted pull request.

Getting Started

Prerequisites: Python 3.10+ and Git.

Fork and clone:

# 1. Fork the repo on GitHub, then clone your fork
git clone https://github.com/YOUR_USERNAME/AcademiQly.git
cd AcademiQly

# 2. Keep your fork in sync with the original
git remote add upstream https://github.com/Huerte/AcademiQly.git

Making Changes

Branch naming:

feat/short-description    # New features
fix/short-description     # Bug fixes
docs/short-description    # Documentation only
chore/short-description   # Maintenance or refactoring

Commit messages: Use plain English. Describe what changed and why:

# Good
git commit -m "fix: resolve grade calculation logic"
git commit -m "feat: add export button for academic reports"
git commit -m "docs: clarify database setup in README"

# Avoid
git commit -m "fix stuff"
git commit -m "update"

Code style:

• Follow the existing Django conventions in the project.
• Keep views and functions short. If something is growing, split it.
• Add a comment when the purpose of something is not immediately obvious.
• Never swallow exceptions silently.

Submitting a Pull Request

1. Push your branch to your fork:

   git push origin feat/your-feature
   

2. Open a Pull Request against Huerte/AcademiQly:main on GitHub.

3. In the PR description, briefly explain: what you changed, why, and how to test it.

4. If your change affects the app's output or behavior, update this README accordingly.

---

Contributors

Huerte Creator

---

License

Distributed under the MIT License. See LICENSE for details.

---

Built to provide students and teachers with real-time subject grade calculation.