mercy-crete

byrain sound

crete a website for school

Landing
Landing

Comments (0)

No comments yet. Be the first!

System Requirements

System Requirement Document

System Requirements Document

Introduction

The purpose of this document is to outline the system requirements for the Mercy-Crete project, which involves creating a website for a school. The website will include features for viewing student attendance, class details, and a landing page to showcase school information.

System Overview

The Mercy-Crete project aims to develop a comprehensive school website that provides essential information and functionalities for students, teachers, and visitors. The website will serve as a platform for managing student data and promoting the school's offerings.

Page 1 of 6

Functional Requirements as Story Points

  • As a School Administrator, I should be able to view student attendance records.
  • As a School Administrator, I should be able to access detailed information about each student's class schedule and performance.
  • As a Visitor, I should be able to view the landing page that showcases information about the school, including its history, mission, and facilities.
  • As a Teacher, I should be able to update student attendance records.
  • As a Teacher, I should be able to enter and update class details for students.
  • As a School Administrator, I should be able to view and manage student birth dates to ensure accurate records.
  • As a Student, I should be able to access and download my hall ticket for examinations to ensure I have the necessary documentation for entry.

User Personas

  • School Administrator: Responsible for managing student data and overseeing school operations.
  • Teacher: Responsible for teaching students and managing class-related information.
  • Visitor: An external user interested in learning more about the school.
  • Student: A user who attends the school and requires access to personal academic information and documentation.
Page 2 of 6

Core User Flows

  • Administrator views attendance: Administrator logs in -> navigates to attendance section -> selects student -> views attendance records.
  • Teacher updates class details: Teacher logs in -> navigates to class management -> selects class -> updates details -> saves changes.
  • Visitor explores landing page: Visitor accesses website -> views landing page -> navigates through school information sections.
  • Student downloads hall ticket: Student logs in -> navigates to examination section -> selects hall ticket -> downloads the document.

Visuals Colors and Theme

  • primary: #2E86C1 (a calm blue representing trust and professionalism)
  • primary_light: #AED6F1 (a lighter blue for hover states and secondary UI)
  • secondary: #F4D03F (a vibrant yellow to complement the primary color)
  • accent: #E74C3C (a bold red for call-to-action buttons and alerts)
  • highlight: #58D68D (a green for active indicators and notifications)
  • bg: #F8F9F9 (a light grey for the page background)
  • surface: #FFFFFF (a clean white for card/panel backgrounds)
  • text: #2C3E50 (a dark blue for primary text and headings)
  • text_muted: #7F8C8D (a muted grey for secondary text and labels)
  • border: #D5D8DC (a subtle grey for borders)
Page 3 of 6

Signature Design Concept

The Mercy-Crete website will feature an interactive landing page that immerses visitors in a virtual tour of the school. The homepage will open with an animated illustration of the school campus, where users can click on different buildings to learn more about each facility. As users hover over elements, subtle animations will bring the campus to life, such as students walking across the quad or birds flying overhead. This interactive experience will be built using motion/react for smooth animations and transitions.

Landing Hero Motion Brief

The landing page will feature a continuously moving 2D composition that tells the story of a day in the life of a student. The animation will begin with a student entering the school gates, attending classes, participating in extracurricular activities, and finally leaving the school at the end of the day. Each scene transition will be smooth and seamless, with interactive elements allowing users to click and learn more about specific activities or facilities. The animation will loop every 10 seconds, providing a dynamic and engaging experience for visitors.

Page 4 of 6

Interaction Model & Motion Direction

  • Intended Interaction Model: Parallax
    • The landing page will utilize a parallax effect to create a sense of depth as users scroll through the content. Background elements will move at a slower pace compared to foreground content, enhancing the storytelling experience.
  • Internal Pages: Static
    • Internal pages such as attendance and class details will focus on clarity and ease of use, with minimal motion to ensure quick access to information.

Non-Functional Requirements

  • The website must be responsive and accessible across all devices and screen sizes.
  • The system should ensure data security and privacy for all student records.
  • The website should load within 3 seconds on standard internet connections.

Tech Stack

  • Frontend: React for Web
  • Backend: Python with FastAPI
  • Database: MySQL or MariaDB, using Alembic for migrations
  • Local Orchestration: Docker, docker-compose
  • Server-side Orchestration: Kubernetes
Page 5 of 6

Assumptions and Constraints

  • The website will be hosted on a cloud platform to ensure scalability and reliability.
  • All user data will be stored securely in compliance with local data protection regulations.
  • The design and functionality will adhere to the school's branding guidelines.

Glossary

  • Parallax: A visual effect where background images move slower than foreground images, creating an illusion of depth.
  • Responsive Design: An approach to web design that ensures a website looks good on all devices, from desktops to smartphones.
  • FastAPI: A modern, fast (high-performance) web framework for building APIs with Python 3.7+.
  • Docker: A platform used to develop, ship, and run applications inside containers.
  • Kubernetes: An open-source system for automating the deployment, scaling, and management of containerized applications.
Page 6 of 6
Landing design preview
Landing: View Info
Login: Sign In
Dashboard: View Stats
Attendance: Select Student
Attendance: View Records
Students: View Class Schedule
Students: View Performance
Dashboard: Manage Users
Landing design preview
Landing: View Info
Login: Sign In
Dashboard: View Stats
Attendance: Select Student
Attendance: View Records
Students: View Class Schedule
Students: View Performance
Dashboard: Manage Users