Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/Muhammadbugaje/NAMETS_Website/llms.txt

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

The Community module shapes how NAMETS presents itself and engages its members. It manages leadership structures (patrons and executives by year), the developer credits page, a public Q&A system, the About page, tutor and membership applications controlled by site-wide toggles, contact information, social media links, and downloadable association documents.

Data Models

Faculty or institutional supporters of NAMETS.
FieldTypeNotes
nameCharFieldFull name
slugSlugFieldAuto-generated from name
designationCharFielde.g., HOD Mechanical Engineering
bioTextFieldBackground information
imageCloudinaryFieldStored in patrons/
hierarchy_orderPositiveIntegerFieldLower numbers appear first
is_activeBooleanFieldControls public visibility
emailEmailFieldUsed for admin notifications (optional)
receive_notificationsBooleanFieldOpt-in to system notifications
Ordered by hierarchy_order then name. Each patron has a detail page at /community/patrons/<slug>/.
ExecutiveYear — groups executives by their active academic session.
FieldTypeNotes
year_labelCharFielde.g., 2025/2026
descriptionTextFieldOptional notes about this leadership cycle
display_orderPositiveIntegerFieldMost recent year should have the lowest value
is_activeBooleanFieldShows or hides the entire year’s team
Executive — an individual officer in a specific year.
FieldTypeNotes
nameCharFieldFull name
roleCharFielde.g., President, PRO
photoCloudinaryFieldStored in executives/
contribution_summaryTextFieldNotable achievements in their tenure
yearForeignKeyLinks to ExecutiveYear
display_orderPositiveIntegerFieldPosition within the year’s listing
is_activeBooleanFieldControls individual visibility
Credits the engineering team that built the NAMETS website.
FieldTypeNotes
nameCharFieldFull name
roleCharFielde.g., Backend Developer
bioTextFieldShort introduction
photoCloudinaryFieldStored in developers/
github_linkURLFieldGitHub profile URL
linkedin_linkURLFieldLinkedIn profile URL
display_orderPositiveIntegerFieldManual sort order
is_activeBooleanFieldShow/hide from developers page
A public Q&A system where members submit questions and admins provide answers.Question
FieldTypeNotes
nameCharFieldSubmitter’s name
emailEmailFieldOptional contact
question_textTextFieldThe question content
categoryCharFieldFree-text label (e.g., Fiqh, Academics)
is_publicBooleanFieldAdmin must set True to show publicly
submitted_atDateTimeFieldAuto-set on submission
Answer
FieldTypeNotes
questionOneToOneFieldLinks to the parent Question
answer_textTextFieldFull response
responded_byForeignKey→UserThe admin who wrote the answer
responded_atDateTimeFieldAuto-set when the answer is saved
Questions are only shown publicly after an admin sets is_public = True.
A singleton content record for the /community/about/ page.
FieldTypeNotes
mission_statementTextFieldNAMETS mission text
vision_statementTextFieldNAMETS vision text
historyTextFieldNarrative history of the association
established_yearCharFielde.g., 1992
Only one AboutPage record should exist. Edit it in the admin to update the public About page.
An application from a student who wants to become a NAMETS tutor.
FieldTypeNotes
nameCharFieldApplicant’s full name
reg_numberCharFieldUniversity matric / student ID
departmentCharFieldFaculty department
cgpaDecimalFieldCumulative GPA (optional)
emailEmailFieldUnique per application
phoneCharFieldContact number
campus_residenceBooleanFieldDoes the applicant live on campus?
strong_coursesTextFieldCourses the applicant excels in
preferred_courseCharFieldCourse they wish to tutor
comfort_levelIntegerFieldSelf-rated teaching comfort (1–5)
teaching_skill_ratingIntegerFieldOptional supplementary skill rating (1–5)
recommendationsTextFieldNames of lecturers or class reps
past_experienceTextFieldPrevious tutoring history
availabilityTextFieldAvailable days/times
has_materialsBooleanFieldApplicant already has teaching materials
collaborate_on_materialsBooleanFieldOpen to co-creating standard materials
is_processedBooleanFieldAdmin marks True after reviewing
submitted_atDateTimeFieldAuto-set on submission
Applications are only accepted when SiteSettings.tutor_applications_open = True.
An application to become a formal NAMETS member.
FieldTypeNotes
nameCharFieldFull name
emailEmailFieldUnique per application
phoneCharFieldContact number
genderCharFieldM, F, or O
reg_numberCharFieldStudent matric number
departmentCharFieldFaculty department
campus_residenceBooleanFieldLives on campus
islamic_knowledgeCharFieldbeginner, intermediate, or advanced
quran_memorizationCharFieldnone, some, half, or whole
skillsM2M → SkillSelect one or more from the Skill model
other_skillCharFieldFree-text if skill not in list
how_work_with_peopleTextFieldShort personal statement
recommendationsTextFieldReferees
is_processedBooleanFieldAdmin marks True after review
Applications are only accepted when SiteSettings.membership_applications_open = True.Strong suit choices for Skill model:
ValueDisplay Label
public_speakingPublic Speaking
techTech (Programming, Design)
graphic_designGraphic Design
programmingProgramming
islamiya_tutorIslamiya Tutor
compassionCompassion/Helping Others
otherOther

URL Routes

All routes are under the community app namespace.
NameURL PatternDescription
patron_list/community/patrons/All active patrons by hierarchy order
patron_detail/community/patrons/<slug>/Individual patron profile
executive_list/community/executives/Executives grouped by year
question_list/community/questions/Public Q&A listing
ask_question/community/ask/Submit a new question
about/community/about/Mission, vision, history, documents
developer_list/community/developers/Website developer credits
tutor_apply/community/apply/tutor/Tutor application form
membership_apply/community/apply/membership/Membership application form

Application Workflows

Tutor Applications

1

Admin opens the application window

Set SiteSettings.tutor_applications_open = True in the Django admin. When False, visiting /community/apply/tutor/ shows a closed-application page.
2

Student submits the form

The applicant fills in their academic background, preferred course, availability, and self-rated comfort level (1–5).
3

Admin reviews the application

In the admin, the application appears in the TutorApplication list. After review, set is_processed = True to mark it as handled.

Membership Applications

1

Admin opens the application window

Set SiteSettings.membership_applications_open = True. When False, the membership form is replaced with a closed-application notice.
2

Student submits the form

The applicant provides personal details, Islamic background (knowledge level and Quran memorisation status), and selects their skills from the Skill model.
3

Admin reviews and processes

Open the MembershipApplication record in the admin and set is_processed = True when done.
Each email address can only submit one tutor application and one membership application. Attempting to submit again with the same email will raise a validation error due to the unique=True constraint on the email field.

About Page Content Management

The AboutPage model is a singleton. To update the About page:
  1. In the Django admin, navigate to Community → About Page.
  2. Edit mission_statement, vision_statement, history, and established_year.
  3. Save — changes are immediately reflected at /community/about/.
Documents shown on the About page are managed separately via NAMETSDocument. Upload files (constitution, reports) in the admin under Community → NAMETS Documents and set is_active = True.

Build docs developers (and LLMs) love