Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/muhammadbugaje/gobarau_backend/llms.txt

Use this file to discover all available pages before exploring further.

Gobarau Academy Backend is the server-side REST API for Gobarau Academy’s school management platform. Built on Django and Django REST Framework, it provides structured endpoints for every operational domain — from student admissions and academic scoring to Qur’an Tahfeez progress tracking, finance management, student welfare, and public content publishing.

Quickstart

Set up the backend locally and make your first authenticated API call in minutes.

Authentication

Obtain JWT access tokens and authorize requests with role-based permissions.

API Reference

Explore all REST endpoints across every app — administration, academics, finance, and more.

Architecture

Understand how the ten application modules relate and how data flows across the system.

What’s Included

Gobarau Academy Backend covers the full lifecycle of school operations across three wings — Regular, Islamiyyah, and Tahfeez.

Academics

Classes, subjects, timetables, scores, report cards, assignments, attendance, and Tahfeez Juz progress.

Admissions

Application intake, entrance exam results, and alumni registration workflows.

Finance

Fee structures, payment records, scholarships, and the school marketplace.

People

Student, teacher, parent, and alumni profiles with enrollment and guardian links.

Welfare

Health profiles, clinic visits, counselling, discipline, and intervention cases.

Communication

Announcements, per-user notifications, direct messages, Q&A board, and career talks.

Services

Library book catalogue, borrow records, fines, bus routes, and transport subscriptions.

Content

News posts, events, gallery albums, school magazine, yearbook, and testimonials.

Administration

Academic sessions, terms, wings, campuses, departments, class levels, and grading scales.

Getting Started

1

Clone and install dependencies

Clone the repository and activate the included virtual environment or install dependencies from requirements.txt.
2

Configure settings

Copy environment variables for database, Cloudinary storage, and secret key into your local Django settings.
3

Run migrations and create a superuser

Apply database migrations with python manage.py migrate and create an admin account with python manage.py createsuperuser.
4

Obtain a JWT token and start calling APIs

Use your credentials to get a JWT token, then authorize requests to any /api/ endpoint. See Authentication for details.
All API endpoints are protected by JWT authentication. You must obtain an access token before making any requests. See the Authentication page for instructions.

Build docs developers (and LLMs) love