diff --git a/README.md b/README.md index 4a9c9596..8f242371 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,18 @@ - # Ultimate Alarm Clock This project aims to build a non-conventional alarm clock with smart features such as auto-dismissal based on phone activity, weather and more! It also includes challenges to ensure you completely wake up and an option to set shared alarms! This is the ULTIMATE alarm clock :) -# Timeline and Project Page - -[GSoC page](https://summerofcode.withgoogle.com/programs/2023/projects/c7GIl1mf) - +

+ + GSOC + +

+ ## Table of Contents - [GetX Pattern](#getx-pattern) - [Database Schema](#database-schema) -- [Installation & Setup](#installation-setup) -- [User Interface & Features](#user-interface-features) +- [Installation & Setup](#installation--setup) +- [User Interface & Features](#user-interface--features) - [Contribution Guidelines](#contribution-guidelines) - [Future Plans](#future-plans) - [Community](#community) @@ -171,9 +172,7 @@ The Flutter Secure Storage library is utilized in the "Ultimate Alarm Clock" pro Flutter Secure Storage is instrumental in ensuring the security and privacy of sensitive user data and preferences, contributing to a seamless and secure user experience in the "Ultimate Alarm Clock" project. - ## Installation & Setup - ### Prerequisites Before getting started, ensure you have the following prerequisites installed on your system: @@ -228,9 +227,15 @@ The "Ultimate Alarm Clock" offers a user-friendly and versatile interface design ### Splash Screen - The app opens with a welcoming splash screen, providing a brief introduction to the application. +splash-1 +splash-2 + ### Light and Dark Modes - The "Ultimate Alarm Clock" offers both light and dark modes to suit your preferred theme and enhance readability in different lighting conditions. +dark +light + ### Home View - After the splash screen, you are directed to the Home View, where you can manage your alarms. - The Home View allows you to: @@ -240,11 +245,12 @@ The "Ultimate Alarm Clock" offers a user-friendly and versatile interface design - Delete alarms. - Edit alarms. - Create new alarms using the floating action button. - - A settings icon in the app bar provides access to the Settings View. -### Settings View +home + +### Settings View - In the Settings View, you can customize various aspects of the app: - Set or edit the weather API key for weather-related features. - Log in with your Google account. @@ -252,8 +258,9 @@ The "Ultimate Alarm Clock" offers a user-friendly and versatile interface design - Toggle the sorting of the alarm list based on time. - Toggle between light and dark modes. -### Add or Update Alarm View +settings +### Add or Update Alarm View - The floating action button in the Home View allows you to create alarms, directing you to the Add or Update Alarm View. - In this view, you can: - Set the alarm time using a time picker or manually entering time using keyboard. @@ -264,6 +271,9 @@ The "Ultimate Alarm Clock" offers a user-friendly and versatile interface design - Choose from challenges, including shake to dismiss, QR code, and math challenges. - Manage shared alarms. +add-alarm-1 +add-alarm-2 + ### Shared Alarms The "Ultimate Alarm Clock" project introduces the feature of shared alarms, allowing users to collaborate with friends, family members, or colleagues to ensure they wake up on time. @@ -386,10 +396,6 @@ If you have any questions regarding something in the project, do not hestitate t ## Future Plans -#### Custom Alarm Ringtones - -- We plan to introduce the ability for users to set custom alarm ringtones. This feature will allow users to select their favorite music or sounds as alarm tones, adding a personal touch to their wake-up experience. - #### Default Alarm Ringtones - In addition to custom ringtones, we will also provide a selection of default alarm tones. These default options will cater to a variety of preferences and ensure that users have a range of options to choose from. diff --git a/assets/images/readme/alarm1.jpg b/assets/images/readme/alarm1.jpg new file mode 100644 index 00000000..11ddc5e3 Binary files /dev/null and b/assets/images/readme/alarm1.jpg differ diff --git a/assets/images/readme/alarm2.jpg b/assets/images/readme/alarm2.jpg new file mode 100644 index 00000000..7e21ea19 Binary files /dev/null and b/assets/images/readme/alarm2.jpg differ diff --git a/assets/images/readme/dark.jpg b/assets/images/readme/dark.jpg new file mode 100644 index 00000000..9cc4978b Binary files /dev/null and b/assets/images/readme/dark.jpg differ diff --git a/assets/images/readme/gsoc.jpg b/assets/images/readme/gsoc.jpg new file mode 100644 index 00000000..d29109f2 Binary files /dev/null and b/assets/images/readme/gsoc.jpg differ diff --git a/assets/images/readme/home.jpg b/assets/images/readme/home.jpg new file mode 100644 index 00000000..e1f6f056 Binary files /dev/null and b/assets/images/readme/home.jpg differ diff --git a/assets/images/readme/light.jpg b/assets/images/readme/light.jpg new file mode 100644 index 00000000..a4fdd1ce Binary files /dev/null and b/assets/images/readme/light.jpg differ diff --git a/assets/images/readme/settings.jpg b/assets/images/readme/settings.jpg new file mode 100644 index 00000000..c6bbc670 Binary files /dev/null and b/assets/images/readme/settings.jpg differ diff --git a/assets/images/readme/splash1.jpg b/assets/images/readme/splash1.jpg new file mode 100644 index 00000000..4789c82d Binary files /dev/null and b/assets/images/readme/splash1.jpg differ diff --git a/assets/images/readme/splash2.jpg b/assets/images/readme/splash2.jpg new file mode 100644 index 00000000..cee534d4 Binary files /dev/null and b/assets/images/readme/splash2.jpg differ diff --git a/pubspec.lock b/pubspec.lock index 21978af9..7fd24242 100644 --- a/pubspec.lock +++ b/pubspec.lock @@ -253,10 +253,10 @@ packages: dependency: transitive description: name: collection - sha256: "4a07be6cb69c84d677a6c3096fcf960cc3285a8330b4603e0d463d15d9bd934c" + sha256: f092b211a4319e98e5ff58223576de6c2803db36221657b46c82574721240687 url: "https://pub.dev" source: hosted - version: "1.17.1" + version: "1.17.2" convert: dependency: transitive description: @@ -756,18 +756,18 @@ packages: dependency: transitive description: name: matcher - sha256: "6501fbd55da300384b768785b83e5ce66991266cec21af89ab9ae7f5ce1c4cbb" + sha256: "1803e76e6653768d64ed8ff2e1e67bea3ad4b923eb5c56a295c3e634bad5960e" url: "https://pub.dev" source: hosted - version: "0.12.15" + version: "0.12.16" material_color_utilities: dependency: transitive description: name: material_color_utilities - sha256: d92141dc6fe1dad30722f9aa826c7fbc896d021d792f80678280601aff8cf724 + sha256: "9528f2f296073ff54cb9fee677df673ace1218163c3bc7628093e7eed5203d41" url: "https://pub.dev" source: hosted - version: "0.2.0" + version: "0.5.0" meta: dependency: transitive description: @@ -1145,10 +1145,10 @@ packages: dependency: transitive description: name: source_span - sha256: dd904f795d4b4f3b870833847c461801f6750a9fa8e61ea5ac53f9422b31f250 + sha256: "53e943d4206a5e30df338fd4c6e7a077e02254531b138a15aec3bd143c1a8b3c" url: "https://pub.dev" source: hosted - version: "1.9.1" + version: "1.10.0" stack_trace: dependency: transitive description: @@ -1201,10 +1201,10 @@ packages: dependency: transitive description: name: test_api - sha256: eb6ac1540b26de412b3403a163d919ba86f6a973fe6cc50ae3541b80092fdcfb + sha256: "75760ffd7786fffdfb9597c35c5b27eaeec82be8edfb6d71d32651128ed7aab8" url: "https://pub.dev" source: hosted - version: "0.5.1" + version: "0.6.0" time: dependency: transitive description: @@ -1373,6 +1373,14 @@ packages: url: "https://pub.dev" source: hosted version: "2.0.1" + web: + dependency: transitive + description: + name: web + sha256: dc8ccd225a2005c1be616fe02951e2e342092edf968cf0844220383757ef8f10 + url: "https://pub.dev" + source: hosted + version: "0.1.4-beta" web_socket_channel: dependency: transitive description: @@ -1438,5 +1446,5 @@ packages: source: hosted version: "3.1.2" sdks: - dart: ">=3.0.0 <4.0.0" + dart: ">=3.1.0-185.0.dev <4.0.0" flutter: ">=3.10.0"