Page 1 of 5
cleared — System Requirements Document
1. Introduction
The "cleared" project is a web application designed to enhance student wellbeing and productivity by reducing academic overwhelm. It is specifically tailored for secondary school students and teachers in Singapore, leveraging a calm and forgiving approach to task management and academic responsibilities.
2. System Overview
The "cleared" app is a web-based platform built using React and Tailwind CSS, aimed at providing a supportive environment for students and teachers. It focuses on simplifying task management, promoting wellbeing, and fostering a collaborative academic community without adding stress or complexity.
Key Features:
- Shared Homework Board
- Personal To-Do List
- Calendar with Google Sync
- Wellbeing Toolkit
- Customizable Identity
Page 2 of 5
3. Functional Requirements as Story Points
- As a student, I should be able to sign up and verify my role to access the app.
- As a teacher, I must verify my MOE email to sign up and access the app.
- As a user, I should be able to post and view homework assignments on a shared board.
- As a student, I should be able to add homework to my personal to-do list and calendar.
- As a teacher, I should be able to delete any post on the homework board.
- As a student, I should be able to create and manage tasks with priority and status.
- As a user, I should be able to view a calendar with color-coded events and tasks.
- As a user, I should be able to drag-and-drop events to reschedule them smoothly.
- As a user, I should be able to sync events with Google Calendar.
- As a student, I should be able to use a Balance Planner to assess my daily activities.
- As a student, I should be able to use a Task Planner to organize tasks.
- As a student, I should be able to use a Pomodoro Timer for focused study sessions.
- As a student, I should be able to use an Anti-procrastination tool to start tasks.
- As a user, I should be able to customize my ID card and dashboard background.
- As a user, I should be able to navigate the app using a sidebar or tab bar.
- As a teacher, I should be able to view workload intelligence without extra data entry.
4. User Personas
- Student: A secondary school student who uses the app to manage homework, tasks, and wellbeing.
- Teacher: A secondary school teacher who oversees student progress and manages assignments.
Page 3 of 5
5. Core User Flows
- Student Onboarding: Sign up → Verify role → Complete profile → Access dashboard.
- Teacher Onboarding: Sign up → Verify MOE email → Complete profile → Access dashboard.
- Homework Management: Post homework → View shared board → Add to personal tasks.
- Task Management: Create task → Set priority/status → Toggle completion.
- Calendar Management: Create event → Drag to reschedule → Sync with Google Calendar.
- Wellbeing Toolkit: Use Balance Planner → Task Planner → Pomodoro Timer → Anti-procrastination tool.
- Customization: Edit ID card → Upload dashboard background → Save changes.
6. Visuals Colors and Theme
- primary: #6a1b9a (Purple)
- primary_light: #9c4dcc (Light Purple)
- secondary: #00796b (Teal)
- accent: #ff4081 (Pink)
- highlight: #ffeb3b (Yellow)
- bg: #ffffff (White)
- surface: #f5f5f5 (Light Grey)
- text: #212121 (Dark Grey)
- text_muted: #757575 (Muted Grey)
- border: #e0e0e0 (Light Grey)
Page 4 of 5
7. Signature Design Concept
Interactive Homework Galaxy: The landing page features an interactive galaxy where each star represents a homework assignment. Users can click on stars to view details, drag them to their task list, and see constellations form as tasks are completed. The galaxy is animated using motion/react for smooth transitions and interactions.
LANDING HERO MOTION BRIEF
The hero section presents a narrative-driven animation: "What if you forget?" A student in a classroom setting is surrounded by floating homework assignments. As they tap on one, it seamlessly integrates into their personal calendar, symbolizing the app's ability to manage tasks effortlessly. The animation loops every 10 seconds, with a pause on hover for interaction.
8. Interaction Model & Motion Direction
- Interaction Model: Animated
- Motion Direction: Smooth transitions with
Framer Motion, including fade-up on scroll and staggered stats.
- Distinctive Mechanics: Each section features unique animations, such as morphing SVGs and kinetic typography.
9. Non-Functional Requirements
- The app must be responsive and function seamlessly on both desktop and mobile devices.
- Ensure high accessibility standards, including contrast and readability.
- Provide real-time updates for shared boards and tasks.
Page 5 of 5
10. Tech Stack
- Frontend: React, Vite, Tailwind CSS, shadcn/ui components
- Icons: lucide-react
- Auth: Platform-handled
- Calendar Sync: Google Calendar URL template
- Realtime Updates: Enabled for shared boards
11. Assumptions and Constraints
- Teachers must have an MOE email for verification.
- No paid APIs are to be used.
- The app should not include gamified elements like streaks or leaderboards.
12. Glossary
- MOE: Ministry of Education
- Eisenhower Matrix: A task prioritization framework
- Pomodoro Timer: A time management method using intervals
- Glassmorphism: A design style using transparency and blur effects
This document outlines the comprehensive requirements for the "cleared" project, ensuring a focused and user-friendly experience for both students and teachers.
No comments yet. Be the first!