System Requirements Document (SRD)

Project Name: gamma-fitness

1. Introduction

The gamma-fitness project is a premium fitness tracker web application designed for individual users to track their fitness journeys. It features a sleek, athletic aesthetic with a dark theme and energetic accent colors, making it visually stunning and motivating. The application is built with scalability in mind, allowing for future integration with Android and iOS platforms.

This document outlines the system requirements for the gamma-fitness web application, ensuring a robust, user-friendly, and visually appealing experience for fitness enthusiasts.

2. System Overview

The gamma-fitness web application is a fitness tracking platform tailored for individual users. It allows users to log workouts, track goals, monitor progress, and stay motivated through achievements and visual elements. Additionally, an admin role is included to oversee user data.

Key features include:

• A dark-themed, athletic aesthetic with bold typography and neon accent colors.
• JWT-based email/password authentication for secure access.
• Role-based access control for users and admin.
• RESTful API backend for future scalability to mobile platforms.

The system is designed to be mobile-first, responsive, and highly interactive, ensuring a premium user experience.

3. Functional Requirements

Core Features:

• As a User, I should be able to log daily exercises with details like Exercise Name, Sets, Reps, Weight (kg/lbs), and Duration (minutes).
• As a User, I should be able to categorize exercises into Strength, Cardio, Sport, or Flexibility.
• As a User, I should be able to log sports activities like Football, Basketball, Cricket, Tennis, and Swimming.
• As a User, I should be able to track running or cycling with Distance (km/miles), Duration, Avg Speed, and Route notes.
• As a User, I should be able to set daily workout goals and view a streak counter for consecutive active days.
• As a User, I should be able to view a dashboard summary of my daily and weekly activities.
• As a User, I should be able to filter and view my exercise history by date or category.
• As a User, I should be able to log body metrics like weight, height, and body measurements.
• As a User, I should be able to save workout templates for quick reuse.
• As a User, I should be able to use a built-in rest timer with audio/visual alerts.
• As a User, I should be able to view motivational quotes and achievement badges.

Admin Features:

• As an Admin, I should be able to view all user data.

4. User Personas

1. Individual User

   • Primary user of the application.
   • Logs workouts, tracks progress, and sets fitness goals.
   • Motivated by achievements, streaks, and visual progress indicators.

2. Admin

   • Oversees user data for monitoring purposes.
   • Has access to view all user logs and metrics but cannot edit or delete user data.

5. Visuals Colors and Theme

• Primary Theme: Dark mode only.
• Accent Colors:
  • Neon Green (#00FF87)
  • Electric Orange (#FF6B35)
• Typography:
  • Headings: Bold display fonts like 'Bebas Neue' or 'Oswald'.
  • Body: Clean sans-serif fonts like 'Roboto' or 'Open Sans'.
• Icons: Use lucide-react icons for consistency.
• Layout: Card-based design with smooth transitions and micro-animations.

6. Signature Design Concept

"Interactive Energy Pulse Dashboard"

The homepage/dashboard will feature a dynamic energy pulse animation that reacts to user activity.

• Visuals:
  A glowing circular progress ring in the center of the screen, pulsing with neon green or electric orange light. The ring dynamically fills based on the user’s daily goal progress.

• Interactions:

  • Hovering over the ring reveals stats like total exercises, calories burned, and duration.
  • Clicking the ring expands it into a full-screen radial menu with quick links to log workouts, view history, or set goals.

• Micro-Animations:

  • Smooth transitions as the ring fills or resets daily.
  • Subtle glow effects on hover and click.
  • Confetti animation when a daily goal is achieved.

• Background:
  A dark, gradient background with faint, animated gridlines resembling a futuristic gym floor.

This concept ensures the homepage is not only functional but also visually captivating and motivating.

7. Non-Functional Requirements

• Performance:

  • The app should load within 2 seconds on a standard 4G connection.
  • Smooth animations and transitions without lag.

• Scalability:

  • Backend designed to support future mobile app integration.
  • RESTful API for platform-agnostic access.

• Security:

  • JWT-based authentication for secure user sessions.
  • Role-based access control to differentiate user and admin permissions.

• Usability:

  • Mobile-first, responsive design.
  • Intuitive navigation and satisfying interactions.

8. Tech Stack

• Frontend:

  • React (JSX)
  • Tailwind CSS

• Backend:

  • Python
  • FastAPI

• Database:

  • MySQL (with Alembic for migrations)

• Authentication:

  • JWT for secure email/password login

• Icons:

  • lucide-react

• Containerization:

  • Docker
  • docker-compose

• Future Mobile Integration:

  • RESTful API for Android/iOS apps

9. Assumptions and Constraints

• The app will initially be a web application but must be scalable to support mobile platforms.
• All data will be stored in React state for now (simulated persistence).
• No external APIs or localStorage will be used in the initial version.
• Admin access is limited to viewing user data without editing capabilities.

10. Glossary

• JWT: JSON Web Token, a secure method for user authentication.
• RESTful API: An API design approach that uses HTTP requests for communication.
• React State: A method in React to manage data within components.
• Alembic: A database migration tool for Python.
• lucide-react: A library of icons for React applications.

This SRD provides a comprehensive roadmap for the development of gamma-fitness, ensuring a premium, scalable, and user-centric fitness tracking experience.