ocean-create System Requirements Document

1. Introduction

The "ocean-create" project is a health and wellness tracking application designed to help users manage their daily routines effectively. The application focuses on tracking sleep, water intake, and medication schedules, providing users with insights into their daily habits and encouraging healthier routines.

2. System Overview

The "ocean-create" application aims to provide a user-friendly platform for individuals to monitor and improve their health and wellness routines. By offering features such as sleep tracking, hydration reminders, and medication scheduling, the application supports users in maintaining consistent and healthy habits.

3. Functional Requirements as Story Points

• As a User, I should be able to track my sleep to compare recommended sleep with actual sleep.
• As a User, I should be able to receive basic analysis of my sleep patterns and consistency.
• As a User, I should be able to set bedtime and wake-up alarms with notifications.
• As a User, I should be able to track my daily water intake and receive hydration reminders.
• As a User, I should be able to schedule my medicine intake with dosage, frequency, and reminder notifications.
• As a User, I should be able to view a notification tracker showing completed, missed, and upcoming reminders.
• As a User, I should be able to access a simple dashboard summarizing my sleep, water intake, medicines, and daily progress.
• As a User, I should have user-friendly controls to mark water intake or medicine as completed.
• As a User, I should be able to view daily and weekly reports highlighting patterns and missed activities.

4. User Personas

• General User: Individuals of all ages who want to track and improve their health and wellness routines.

5. Core User Flows

• User sets up sleep tracking -> User receives sleep analysis -> User adjusts sleep habits based on insights.
• User logs water intake -> User receives hydration reminders -> User marks water intake as completed.
• User schedules medication -> User receives medication reminders -> User marks medication as taken.
• User views dashboard -> User checks daily progress and reports -> User identifies areas for improvement.

6. Visuals Colors and Theme

• primary: #4CAF50 (Green for health and wellness)
• primary_light: #81C784 (Lighter green for hover states)
• secondary: #FFEB3B (Yellow for alerts and notifications)
• accent: #FF5722 (Orange for call-to-action buttons)
• highlight: #FFC107 (Amber for active indicators)
• bg: #FFFFFF (White for a clean background)
• surface: #F5F5F5 (Light grey for card/panel backgrounds)
• text: #212121 (Dark grey for primary text)
• text_muted: #757575 (Muted grey for secondary text)
• border: #E0E0E0 (Light grey for borders)

7. Signature Design Concept

The "ocean-create" application will feature an interactive dashboard that resembles a serene ocean scene. The dashboard will have animated waves that gently move in the background, symbolizing the flow of a healthy routine. Users can interact with the waves by tapping on them to reveal their daily progress in a visually engaging way. The waves will change color based on the time of day, providing a dynamic and calming user experience. This concept will be implemented using motion/react for smooth animations and transitions.

LANDING HERO MOTION BRIEF

The landing page will feature an animated sequence where a droplet of water falls into a calm ocean, creating ripples that transform into icons representing sleep, hydration, and medication. As the ripples expand, they reveal the user's daily progress and insights. This animation will loop every 10 seconds, providing a continuous and soothing visual narrative. The animation will be built using CSS and motion/react to ensure accessibility and responsiveness.

8. Interaction Model & Motion Direction

• Intended Interaction Model: Animated
  • The landing page will feature moderate scroll-triggered reveals and hover transitions. Interactive elements will have spring physics to enhance user engagement.
• Internal Pages: Static
  • Internal pages such as dashboards and reports will prioritize layout clarity with minimal motion to ensure ease of use.

9. Non-Functional Requirements

• The application must be mobile-friendly and accessible to users of all ages.
• The design should prioritize simplicity and ease of navigation.
• The application must include a disclaimer stating that it supports routine tracking and does not replace professional medical advice.

10. Tech Stack

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

11. Assumptions and Constraints

• The application will be used primarily on mobile devices.
• Users will have access to the internet to receive notifications and updates.
• The application will not provide medical advice or replace professional healthcare services.

12. Glossary

• Sleep Tracking: Monitoring and recording sleep patterns and duration.
• Hydration Reminder: Notifications to encourage regular water intake.
• Medication Scheduling: Setting reminders for medicine intake based on dosage and frequency.
• Dashboard: A user interface that provides an overview of key metrics and progress.