System Requirements Document (SRD)

Project Name: raven-supplement

1. Introduction

The raven-supplement project is designed to empower clients to log their own supplement intake and track their progress independently. This system aims to provide a seamless and intuitive experience for users, while also offering insights and analytics for coaches, trainers, or nutritionists.

Developed with Soeb Salim's vision in mind, the system will cater to users in the United Kingdom, adhering to locale-specific defaults such as GMT timezone and GBP currency where applicable.

This document outlines the system requirements for raven-supplement, ensuring clarity and alignment with the project's goals.

2. System Overview

The raven-supplement system is a client-centric supplement tracking platform. It enables users to log their daily supplement intake, monitor their progress, and receive actionable insights. The system will also provide coaches or admins with an overview of client activity, fostering better health management and accountability.

Key features include:

• A user-friendly interface for supplement logging.
• Progress tracking with visual analytics.
• Notifications and reminders for supplement intake.
• Secure data storage and privacy compliance.

The system will leverage modern technologies to ensure scalability, reliability, and ease of use.

3. Functional Requirements

As story points:

• As a Client, I should be able to log my daily supplement intake.
• As a Client, I should be able to view my progress over time through charts and analytics.
• As a Client, I should receive reminders to take my supplements.
• As a Coach/Admin, I should be able to view an overview of client activity and progress.
• As a Client, I should be able to edit or delete supplement logs.
• As a Client, I should be able to set goals for supplement intake.
• As a Client, I should be able to export my progress data for personal use or sharing.

4. User Personas

Client

• Description: The primary user of the system. Logs their supplement intake, tracks progress, and receives reminders.
• Goals: Stay consistent with supplement intake, monitor health improvements, and achieve personal goals.

Coach/Admin

• Description: Secondary user of the system. Monitors client activity and provides guidance based on progress data.
• Goals: Ensure clients are consistent, analyze trends, and offer actionable advice.

5. Visuals Colors and Theme

Color Palette

The raven-supplement project will feature a modern and calming color palette to evoke trust, health, and vitality:

• Background: #F5F9FF (Soft Sky Blue)
• Surface: #FFFFFF (Pure White)
• Text: #2D3748 (Charcoal Gray)
• Accent: #4CAF50 (Vibrant Green)
• Muted Tones: #B0BEC5 (Cool Gray)

This palette ensures a clean and professional aesthetic while maintaining a focus on health and wellness.

6. Signature Design Concept

Concept: Interactive Health Dashboard

The homepage of raven-supplement will feature an Interactive Health Dashboard that dynamically updates based on user activity.

Key Features:

• Circular Progress Rings: Represent daily supplement intake, with colors shifting from muted gray (incomplete) to vibrant green (complete).
• Animated Charts: Progress graphs that animate as data is updated, providing a sense of accomplishment.
• Personalized Greeting: A dynamic welcome message that changes based on the time of day (e.g., "Good Morning, Soeb! Here's your progress for today.")
• Micro-Interactions: Hover effects on buttons and icons that provide subtle feedback, such as glowing edges or slight scaling.
• Gamification Elements: Badges and achievements for consistent logging, encouraging user engagement.

The dashboard will be visually striking, intuitive, and designed to make users feel motivated and in control of their health journey.

7. Non-Functional Requirements

• Performance: The system should load within 2 seconds for all major pages.
• Scalability: Support up to 10,000 concurrent users.
• Security: Ensure data encryption (AES-256) and compliance with GDPR for UK-based users.
• Availability: 99.9% uptime guaranteed.
• Accessibility: WCAG 2.1 AA compliance for accessibility.

8. Tech Stack

Frontend

• React for Web

Backend

• Python
• FastAPI

Database

• MySQL (with Alembic for migrations)

AI Models

• GPT 5.4 for user-friendly responses

AI Tools

• Langchain

Local Orchestration

• Docker
• docker-compose

Server-Side Orchestration

• Kubernetes

9. Assumptions and Constraints

Assumptions

• Clients will have access to smartphones or computers to log supplements.
• Coaches/Admins will primarily use the system for monitoring and analysis.
• Notifications will be sent via email or push notifications.

Constraints

• The system must comply with GDPR regulations for data privacy.
• Limited budget for initial development phases.

10. Glossary

• Client: The end-user who logs supplements and tracks progress.
• Coach/Admin: A secondary user who monitors client activity.
• Supplement: Any health-related product logged by the client (e.g., vitamins, protein powders).
• GDPR: General Data Protection Regulation, applicable in the UK for data privacy.
• AES-256: Advanced Encryption Standard, a method for securing sensitive data.