Skip to content

Commit

Permalink
Updated the repo Readme file (#182)
Browse files Browse the repository at this point in the history
* Add GSOC image

* Add view screenshots

* Update README.md

* Fix links

* Alter future-plans

* Update README.md

* Update README.md

* resized images

* Add images

* add readme assets

* update links to relative links

* alt fixes
  • Loading branch information
its-me-abhishek authored Dec 10, 2023
1 parent 8465ab9 commit ad88d2f
Show file tree
Hide file tree
Showing 11 changed files with 41 additions and 27 deletions.
38 changes: 22 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
@@ -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)

<p align="center">
<a href="https://summerofcode.withgoogle.com/programs/2023/projects/c7GIl1mf">
<img src="./assets/images/readme/gsoc.jpg" alt="GSOC">
</a>
</p>

## 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)
Expand Down Expand Up @@ -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:

Expand Down Expand Up @@ -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.

<img src="./assets/images/readme/splash1.jpg" height="400" alt="splash-1">
<img src="./assets/images/readme/splash2.jpg" height="400" alt="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.

<img src="./assets/images/readme/dark.jpg" height="400" alt="dark">
<img src="./assets/images/readme/light.jpg" height="400" alt="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:
Expand All @@ -240,20 +245,22 @@ 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
<img src="./assets/images/readme/home.jpg" height="400" alt="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.
- Toggle haptic feedback on/off.
- Toggle the sorting of the alarm list based on time.
- Toggle between light and dark modes.

### Add or Update Alarm View
<img src="./assets/images/readme/settings.jpg" height="400" alt="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.
Expand All @@ -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.

<img src="./assets/images/readme/alarm1.jpg" height="400" alt="add-alarm-1">
<img src="./assets/images/readme/alarm2.jpg" height="400" alt="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.
Expand Down Expand Up @@ -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.
Expand Down
Binary file added assets/images/readme/alarm1.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/images/readme/alarm2.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/images/readme/dark.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/images/readme/gsoc.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/images/readme/home.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/images/readme/light.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/images/readme/settings.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/images/readme/splash1.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/images/readme/splash2.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
30 changes: 19 additions & 11 deletions pubspec.lock
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down Expand Up @@ -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:
Expand Down Expand Up @@ -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:
Expand Down Expand Up @@ -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:
Expand Down Expand Up @@ -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:
Expand Down Expand Up @@ -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"

0 comments on commit ad88d2f

Please sign in to comment.