System Requirements Document for Shiny-Fitness

1. Introduction

Shiny-Fitness is a full-stack web application designed to help users create and manage personalized workout and diet plans. The application leverages AI to provide tailored suggestions based on individual fitness goals, such as bulking, weight loss, muscle gain, or maintaining physique. Users can customize their plans and receive comprehensive guidance from diet to exercise.

2. System Overview

Shiny-Fitness is an AI-driven fitness tracker web app that offers personalized workout and diet planning. The application supports users in creating and modifying workout plans, adding exercises, sets, and reps, and developing diet plans aligned with their fitness objectives. AI suggestions enhance user experience by offering tailored advice based on current plans and goals.

2a. Product Interpretation and Delivery Boundary

• Domain Descriptors:

  • AI-driven fitness planning: The product uses AI to provide personalized workout and diet plans.

• What is being built:

  • A web application with AI-driven features for personalized fitness planning, including workout and diet plans.

• Excluded Assumptions:

  • Generic fitness app features without AI integration.
  • Non-personalized workout or diet plans.

• First-party Custom Pages:

  • Fitness Tracker Entry
  • Workout Plan
  • Diet Plan
  • Landing
  • Authentication

• Access:

  • Application-owned identity with authentication required for accessing personalized plans.

• Behavior Contracts:

  • Create and modify workout plan: Users can initiate workout plan creation or modification, resulting in a personalized workout plan.
  • Create and modify diet plan: Users can initiate diet plan creation or modification, resulting in a personalized diet plan.
  • AI-driven suggestions: Users can request AI-generated workout and diet suggestions based on current plans and goals.
  • Locate and access the fitness tracker web app: Users can find and access the application via a web browser.

2b. Page Content and Component Coverage

• Fitness Tracker Entry:

  • Overview of the application and its features.
  • Access to workout and diet planning tools.
  • Public entry point for new users.

• Workout Plan:

  • Interface for creating and modifying workout plans.
  • Options to add exercises, sets, and reps.
  • AI-driven suggestions for workout improvements.

• Diet Plan:

  • Interface for creating and modifying diet plans.
  • Options to set diet preferences and fitness goals.
  • AI-driven suggestions for diet improvements.

• Landing:

  • Public-facing page to orient and acquire users.
  • Introduction to the app's features and benefits.

• Authentication:

  • Combined sign-up, login, and session management interface.
  • Secure access to personalized plans.

3. Functional Requirements as Story Points

• As a Fitness Enthusiast, I should be able to create and modify my workout plan by adding exercises, sets, and reps to personalize my fitness routine. explicit
• As a Fitness Enthusiast, I should be able to create and modify my diet plan based on my fitness goals to ensure my dietary needs are met. explicit
• As a Fitness Enthusiast, I should be able to receive AI-driven suggestions for my workout and diet plans to optimize my fitness journey. required_inference
• As a Fitness Enthusiast, I should be able to locate and access the fitness tracker web app through a web browser to begin using the application. explicit
• As a Fitness Enthusiast, I should be able to sign up, log in, and manage my session to securely access my personalized workout and diet plans. required_inference

4. User Personas

• Fitness Enthusiast: The primary user who plans and tracks workouts and diet using the app.

5. Core User Flows

1. Accessing the Application:

   • User navigates to the Fitness Tracker Entry page.
   • User explores the application features and decides to sign up or log in.

2. Creating a Workout Plan:

   • User logs in and navigates to the Workout Plan page.
   • User adds exercises, sets, and reps.
   • User saves the workout plan and receives AI suggestions.

3. Creating a Diet Plan:

   • User navigates to the Diet Plan page.
   • User sets diet preferences and fitness goals.
   • User saves the diet plan and receives AI suggestions.

4. Receiving AI Suggestions:

   • User requests AI-driven suggestions for workout and diet plans.
   • User reviews and applies suggestions to optimize plans.

6. Visuals Colors and Theme

• Primary: #007BFF
• Primary Light: #66B2FF
• Secondary: #6C757D
• Accent: #28A745
• Highlight: #FFC107
• Background: #F8F9FA
• Surface: #FFFFFF
• Text: #212529
• Text Muted: #6C757D
• Border: #DEE2E6

7. Signature Design Concept

The design concept for Shiny-Fitness will focus on a clean, modern interface that emphasizes ease of use and accessibility. The Landing page will feature a dynamic hero section with subtle animations to engage users. The Workout and Diet Plan pages will prioritize clarity and functionality, with intuitive navigation and interactive elements to enhance user experience. The color palette will be consistent across the application, providing a cohesive and professional look.

8. Interaction Model & Motion Direction

• Landing Page: Animated with subtle motion to engage users and highlight key features.
• Internal Pages (Workout Plan, Diet Plan): Static with minimal motion to prioritize clarity and functionality.

9. Non-Functional Requirements

• The application must ensure secure access control for user data. required_inference
• The application should provide a responsive design for optimal viewing on various devices. required_inference

10. Tech Stack

• Frontend: React for Web
• Backend: Python, FastAPI
• Database: MySQL or MariaDB, using Alembic for migrations
• AI Models: GPT 5.4 for user-friendly response
• Local Orchestration: Docker, docker-compose

11. Assumptions and Constraints

• The application assumes users have internet access to use the web app.
• AI-driven features require integration with AI models for personalized suggestions.

12. Glossary

• AI: Artificial Intelligence
• Fitness Enthusiast: Primary user persona for the application
• Workout Plan: A personalized exercise routine
• Diet Plan: A personalized dietary regimen
• Authentication: Process of verifying user identity to access the application