YOGA BY SUKU System Requirements Document

1. Introduction

This document outlines the system requirements for the "YOGA BY SUKU" project, a yoga application designed for beginners. The application will provide instructional videos for yoga poses, along with features for progress tracking, login, and an admin panel for content management.

2. System Overview

2a. Product Interpretation and Delivery Boundary

• Domain Descriptor: Yoga Instruction

  • Source Evidence: The app provides instructional videos for yoga poses.
  • Confidence: 0.9

• Product Intent: A yoga app for beginners with instructional videos.

• Included Features:

  • Instructional videos for yoga poses.
  • Account sign-up, login, and session access.
  • Authorization for privileged workflow access.
  • Admin panel for managing instructional videos and user accounts.

• Excluded Assumptions:

  • Generic fitness tracking features.
  • Advanced yoga techniques.

• Access: Application-owned identity.

• Behavior Contracts:

  • Manage Instructional Videos: Admin uploads or updates instructional videos, updating the video library.
  • View Instructional Yoga Videos: Beginner User selects a yoga pose or routine to learn, and the instructional video is presented.

2b. Page Content and Component Coverage

• Yoga Videos Page:

  • Displays a list of available yoga poses and routines.
  • Allows users to select a pose or routine to view the instructional video.
  • Includes video playback controls.
  • Provides feedback if a video fails to load or play.

• Authentication Page:

  • Provides login and sign-up functionality.
  • Manages session access for authenticated users.

• Admin Panel:

  • Allows admins to upload and manage instructional videos.
  • Provides tools for managing user accounts.

3. Functional Requirements as Story Points

• As a Beginner User, I should be able to view instructional videos for selected yoga poses or routines. basic_default
• As an Admin, I should be able to upload and manage instructional videos to ensure the library is up-to-date. explicit
• As an Admin, I should be able to manage user accounts to maintain the app's user base. required_inference
• As a User, I should be able to sign up and log in to access personalized features. required_inference

4. User Personas

• Beginner User: Primary user engaging with yoga content and tracking progress.
• Admin: Responsible for managing app content and user accounts.

5. Core User Flows

Beginner User Flow

1. Access the Yoga Videos page.
2. Browse the list of yoga poses and routines.
3. Select a pose or routine to view the instructional video.
4. Watch the video and follow along with the instructions.

Admin Flow

1. Access the Admin Panel.
2. Upload new instructional videos or update existing ones.
3. Manage user accounts as needed.

6. Visuals Colors and Theme

• Primary: #4CAF50 (Green)
• Primary Light: #81C784
• Secondary: #FFEB3B (Yellow)
• Accent: #FF5722 (Orange)
• Highlight: #FFC107 (Amber)
• Background: #F5F5F5 (Light Grey)
• Surface: #FFFFFF (White)
• Text: #212121 (Dark Grey)
• Text Muted: #757575 (Grey)
• Border: #E0E0E0 (Light Grey)

7. Signature Design Concept

The Yoga Videos page will feature a clean and calming design, using a palette of greens and neutrals to evoke a sense of tranquility. The page will have a simple layout with a list of yoga poses and routines, each accompanied by a thumbnail image. Upon selection, the instructional video will play in a dedicated viewing area with standard playback controls. The design will focus on ease of use and accessibility, ensuring that users can easily navigate and engage with the content.

8. Interaction Model & Motion Direction

• Yoga Videos Page: Animated with moderate scroll-triggered reveals and hover transitions to enhance user engagement without overwhelming the content.
• Admin Panel: Static to prioritize clarity and task completion.

9. Non-Functional Requirements

• The application must ensure secure access control for user accounts and admin functionalities. required_inference

10. Tech Stack

• Frontend: React for Web
• Backend: Python with FastAPI
• Database: MySQL or MariaDB, using Alembic for migrations
• Local Orchestration: Docker and docker-compose

11. Assumptions and Constraints

• The application will not include advanced yoga techniques or generic fitness tracking features.
• Persistent identity is required for Admins to manage instructional videos and user accounts.

12. Glossary

• Beginner User: A user engaging with the app to learn yoga poses and routines.
• Admin: A user with privileges to manage content and user accounts within the app.
• Instructional Video: A video that demonstrates and instructs on performing a yoga pose or routine.