Saas for Students

Introduction

The "Saas for Students" project aims to develop a Software as a Service (SaaS) platform that provides lectures to students in Germany. This platform will cater to the educational needs of students by offering a variety of lectures and resources online.

System Overview

The system will be a web-based platform designed to deliver educational content to students. It will support features such as user registration, course enrollment, lecture streaming, and progress tracking. The platform will be optimized for students in Germany, considering local educational standards and requirements.

Functional Requirements as Story Points

• As a Student, I should be able to register on the platform using my email address.
• As a Student, I should be able to browse available lectures and courses.
• As a Student, I should be able to enroll in a course and access its lectures.
• As a Student, I should be able to stream lectures online.
• As a Student, I should be able to track my progress in each course.
• As an Admin, I should be able to manage course content and lecture schedules.
• As an Admin, I should be able to monitor student enrollment and progress.

User Personas

• Student: The primary user who enrolls in courses and consumes lecture content.
• Admin: The user responsible for managing course content, schedules, and monitoring student activities.

Core User Flows

• Student Registration: Student visits the website -> Fills out registration form -> Submits form -> Receives confirmation email -> Confirms registration.
• Course Enrollment: Student logs in -> Browses available courses -> Selects a course -> Enrolls in the course -> Gains access to course materials.
• Lecture Streaming: Student logs in -> Navigates to enrolled courses -> Selects a lecture -> Streams the lecture online.
• Progress Tracking: Student logs in -> Views enrolled courses -> Checks progress dashboard -> Reviews completed and pending lectures.

Visuals Colors and Theme

• primary: #0044cc (a strong blue to convey trust and professionalism)
• primary_light: #3366ff (a lighter blue for hover states and secondary UI)
• secondary: #ffcc00 (a vibrant yellow to complement the primary color)
• accent: #ff6600 (an orange for call-to-action buttons and highlights)
• highlight: #00cc44 (a green for notifications and active indicators)
• bg: #f4f4f9 (a light grey for the page background)
• surface: #ffffff (white for card and panel backgrounds)
• text: #333333 (dark grey for primary text)
• text_muted: #777777 (a softer grey for secondary text and labels)
• border: #dddddd (a subtle grey for borders)

Signature Design Concept

The homepage will feature an interactive "Lecture Galaxy" where each star represents a different lecture or course. Users can click on a star to view more details about the lecture, drag to rotate the galaxy, and hover to highlight connections between related courses. This concept will be implemented using @react-three/fiber for 3D interactions and gsap for smooth animations. The galaxy will dynamically update to show new courses and lectures as they are added to the platform.

Landing Hero Motion Brief

The landing page will feature a 2D animated scene where a student's journey is visualized. The animation will start with a student entering a virtual classroom, interacting with digital content, and finally achieving academic success. This loop will be created using motion/react for smooth transitions and will include interactive elements like clickable icons and hover effects. The animation will be responsive and adapt to different screen sizes, ensuring a consistent user experience.

Interaction Model & Motion Direction

• Intended Interaction Model: Animated
  • The landing page will feature moderate scroll-triggered reveals, hover transitions, and spring physics on interactive elements to create an engaging user experience.
• Internal Pages: Static
  • Internal pages such as dashboards and course content will prioritize layout clarity with minimal motion to ensure ease of use.

Non-Functional Requirements

• The platform must support high availability and handle concurrent users efficiently.
• The system should ensure data privacy and comply with GDPR regulations.
• The website must be responsive and accessible on various devices and screen sizes.

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

Assumptions and Constraints

• The platform will primarily target students in Germany, and all content will be in German.
• The system will require a stable internet connection for streaming lectures.
• The platform will adhere to local educational standards and regulations.

Glossary

• SaaS: Software as a Service
• GDPR: General Data Protection Regulation
• UI: User Interface
• UX: User Experience
• API: Application Programming Interface

This document outlines the requirements and design considerations for the "Saas for Students" project, ensuring a comprehensive approach to developing a platform that meets the educational needs of students in Germany.