|
1 | | -# sleep_tracker |
| 1 | +# π SleepWell β Sleep Better. Live Better. |
2 | 2 |
|
3 | | -A new Flutter project. |
| 3 | +A Flutter Android app for tracking daily sleep patterns, getting personalized health insights, and improving sleep quality. |
4 | 4 |
|
5 | | -## Getting Started |
| 5 | +[](https://flutter.dev) |
| 6 | +[](https://dart.dev) |
| 7 | +[](https://android.com) |
| 8 | +[](https://play.google.com/store/apps/details?id=com.pavankumar.sleepwell) |
| 9 | +[](LICENSE) |
6 | 10 |
|
7 | | -This project is a starting point for a Flutter application. |
| 11 | +--- |
8 | 12 |
|
9 | | -A few resources to get you started if this is your first Flutter project: |
| 13 | +## π± Screenshots |
10 | 14 |
|
11 | | -- [Learn Flutter](https://docs.flutter.dev/get-started/learn-flutter) |
12 | | -- [Write your first Flutter app](https://docs.flutter.dev/get-started/codelab) |
13 | | -- [Flutter learning resources](https://docs.flutter.dev/reference/learning-resources) |
| 15 | +| Home Screen | Sleep Calendar | Weekly Report | About Screen | |
| 16 | +|:-----------:|:--------------:|:-------------:|:------------:| |
| 17 | +|  |  |  |  | |
14 | 18 |
|
15 | | -For help getting started with Flutter development, view the |
16 | | -[online documentation](https://docs.flutter.dev/), which offers tutorials, |
17 | | -samples, guidance on mobile development, and a full API reference. |
| 19 | +--- |
| 20 | + |
| 21 | +## β¨ Features |
| 22 | + |
| 23 | +### π΄ Sleep Tracking |
| 24 | +- Log bed time and wake time daily |
| 25 | +- Personalized sleep recommendations based on age and gender |
| 26 | +- Real-time sleep score calculation |
| 27 | + |
| 28 | +### π Analytics & Reports |
| 29 | +- Weekly sleep bar chart visualization |
| 30 | +- Sleep risk analysis (chronic deprivation detection) |
| 31 | +- Personalized tips based on your sleep patterns |
| 32 | +- Email your weekly report directly to yourself |
| 33 | + |
| 34 | +### π
Sleep Calendar |
| 35 | +- Monthly view with color-coded sleep quality |
| 36 | +- Tap any past date to log or edit sleep |
| 37 | +- Visual legend (Critical / Low / Good / High) |
| 38 | + |
| 39 | +### π΅ Ambient Music |
| 40 | +- 3 built-in tracks: Deep Sleep, Rain Sounds, Ocean Waves |
| 41 | +- Smooth fade in/out transitions |
| 42 | +- Volume slider + mute toggle |
| 43 | +- Continuous loop playback |
| 44 | + |
| 45 | +### π¨ Themes |
| 46 | +- 3 beautiful themes: Morning, Midday, Night |
| 47 | +- Auto-detects time of day |
| 48 | +- Manual toggle from home screen |
| 49 | + |
| 50 | +### π Notifications |
| 51 | +- Daily 8AM sleep log reminder |
| 52 | +- Monday weekly report notification |
| 53 | +- Toggle on/off from About screen |
| 54 | + |
| 55 | +### π€ User Profile |
| 56 | +- Personalized onboarding (name, age, gender, email) |
| 57 | +- Profile photo upload |
| 58 | +- All data stored locally β full privacy |
| 59 | + |
| 60 | +--- |
| 61 | + |
| 62 | +## π οΈ Tech Stack |
| 63 | + |
| 64 | +| Category | Technology | |
| 65 | +|----------|-----------| |
| 66 | +| Framework | Flutter 3.41.6 | |
| 67 | +| Language | Dart 3.11.4 | |
| 68 | +| Storage | SharedPreferences (local) | |
| 69 | +| Charts | fl_chart | |
| 70 | +| Audio | audioplayers | |
| 71 | +| Fonts | Google Fonts (Poppins) | |
| 72 | +| Notifications | flutter_local_notifications | |
| 73 | +| Review | in_app_review | |
| 74 | +| Email | url_launcher | |
| 75 | + |
| 76 | +--- |
| 77 | + |
| 78 | +## π Getting Started |
| 79 | + |
| 80 | +### Prerequisites |
| 81 | +```bash |
| 82 | +# Install Flutter |
| 83 | +https://docs.flutter.dev/get-started/install |
| 84 | + |
| 85 | +# Verify installation |
| 86 | +flutter doctor |
| 87 | +``` |
| 88 | + |
| 89 | +### Clone & Run |
| 90 | +```bash |
| 91 | +# Clone the repo |
| 92 | +git clone https://github.com/AshBornCommander/sleep-tracker.git |
| 93 | +cd sleep-tracker |
| 94 | + |
| 95 | +# Install dependencies |
| 96 | +flutter pub get |
| 97 | + |
| 98 | +# Run on connected device |
| 99 | +flutter run |
| 100 | + |
| 101 | +# Build release APK |
| 102 | +flutter build appbundle --release |
| 103 | +``` |
| 104 | + |
| 105 | +--- |
| 106 | + |
| 107 | +## π Project Structure |
| 108 | + |
| 109 | +``` |
| 110 | +lib/ |
| 111 | +βββ main.dart # App entry point |
| 112 | +βββ theme/ |
| 113 | +β βββ app_theme.dart # Colors, gradients, theme modes |
| 114 | +βββ utils/ |
| 115 | +β βββ responsive.dart # R class - responsive sizing |
| 116 | +βββ screens/ |
| 117 | +β βββ splash_screen.dart # Animated splash |
| 118 | +β βββ onboarding_screen.dart # User setup flow |
| 119 | +β βββ home_screen.dart # Main sleep logging screen |
| 120 | +β βββ calendar_screen.dart # Monthly sleep calendar |
| 121 | +β βββ report_screen.dart # Weekly reports & analytics |
| 122 | +β βββ about_screen.dart # Profile & settings |
| 123 | +βββ widgets/ |
| 124 | +β βββ music_control_widget.dart # Ambient music player |
| 125 | +βββ services/ |
| 126 | + βββ audio_service.dart # Music playback management |
| 127 | + βββ notification_service.dart # Local notifications |
| 128 | +``` |
| 129 | + |
| 130 | +--- |
| 131 | + |
| 132 | +## π¨ Design System |
| 133 | + |
| 134 | +``` |
| 135 | +Primary: #6C63FF (Purple) |
| 136 | +Accent: #00D2FF (Cyan) |
| 137 | +Background: #0A0E21 (Midnight Blue) |
| 138 | +Card: #1D1E33 (Dark Navy) |
| 139 | +Font: Poppins (Google Fonts) |
| 140 | +``` |
| 141 | + |
| 142 | +--- |
| 143 | + |
| 144 | +## π¦ Dependencies |
| 145 | + |
| 146 | +```yaml |
| 147 | +dependencies: |
| 148 | + google_fonts: ^6.0.0 |
| 149 | + shared_preferences: ^2.0.0 |
| 150 | + fl_chart: ^0.68.0 |
| 151 | + audioplayers: ^6.0.0 |
| 152 | + image_picker: ^1.0.0 |
| 153 | + flutter_local_notifications: ^17.0.0 |
| 154 | + timezone: ^0.9.0 |
| 155 | + in_app_review: ^2.0.0 |
| 156 | + url_launcher: ^6.0.0 |
| 157 | +``` |
| 158 | +
|
| 159 | +--- |
| 160 | +
|
| 161 | +## π Privacy |
| 162 | +
|
| 163 | +SleepWell takes privacy seriously: |
| 164 | +- β
All data stored **locally on device only** |
| 165 | +- β
No data transmitted to external servers |
| 166 | +- β
No ads, no tracking, no analytics |
| 167 | +- β
Uninstalling the app deletes all data |
| 168 | +
|
| 169 | +[Read full Privacy Policy](https://ashborncommander.github.io/sleep-tracker/privacy-policy.html) |
| 170 | +
|
| 171 | +--- |
| 172 | +
|
| 173 | +## π Documentation |
| 174 | +
|
| 175 | +| Document | Description | |
| 176 | +|----------|-------------| |
| 177 | +| [Privacy Policy](https://ashborncommander.github.io/sleep-tracker/privacy-policy.html) | Data handling and user rights | |
| 178 | +| [Dev Log](DEVLOG.md) | Complete development history and lessons learned | |
| 179 | +| [Music Setup](MUSIC_SETUP.md) | How ambient music was generated | |
| 180 | +| [FlutterForge Agent](FlutterForge_Agent_Prompt.md) | AI prompt for building Flutter apps | |
| 181 | +
|
| 182 | +--- |
| 183 | +
|
| 184 | +## πͺ Download |
| 185 | +
|
| 186 | +<a href="https://play.google.com/store/apps/details?id=com.pavankumar.sleepwell"> |
| 187 | + <img src="https://play.google.com/intl/en_us/badges/static/images/badges/en_badge_web_generic.png" width="200"/> |
| 188 | +</a> |
| 189 | +
|
| 190 | +--- |
| 191 | +
|
| 192 | +## π¨βπ» Developer |
| 193 | +
|
| 194 | +**Pavan Kumar Malladi** |
| 195 | +Data Engineer & App Developer |
| 196 | +Phoenix, Arizona |
| 197 | +
|
| 198 | +- GitHub: [@AshBornCommander](https://github.com/AshBornCommander) |
| 199 | +- Email: pavankumarmalladi7@gmail.com |
| 200 | +
|
| 201 | +--- |
| 202 | +
|
| 203 | +## π License |
| 204 | +
|
| 205 | +This project is licensed under the MIT License. |
| 206 | +
|
| 207 | +--- |
| 208 | +
|
| 209 | +*Built with β€οΈ using Flutter β From zero mobile experience to Google Play Store!* π |
0 commit comments