Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/moniaar/pomtom
A flutter app that helps you as a timer and a study buddy with the power of AI.
https://github.com/moniaar/pomtom
ai android android-application dart flutter html kotlin kotlin-android pomodoro pomodoro-timer
Last synced: 7 days ago
JSON representation
A flutter app that helps you as a timer and a study buddy with the power of AI.
- Host: GitHub
- URL: https://github.com/moniaar/pomtom
- Owner: Moniaar
- Created: 2024-07-07T08:06:07.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2024-08-25T16:23:53.000Z (3 months ago)
- Last Synced: 2024-08-26T17:13:38.283Z (3 months ago)
- Topics: ai, android, android-application, dart, flutter, html, kotlin, kotlin-android, pomodoro, pomodoro-timer
- Language: Dart
- Homepage:
- Size: 296 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Pomtom
A minimal pomodoro app that will be your study buddy! :)
- Note: This is my final graduation project with ALX_SE program.
## Table of Contents
- [Features](#features)
- [Getting Started](#getting-started)
- [Prerequisites](#prerequisites)
- [Installation](#installation)
- [Usage](#usage)
- [Screenshots](#screenshots)
- [Architecture](#architecture)
- [Configuration](#configuration)
- [Testing](#testing)
- [Contributing](#contributing)
- [License](#license)
- [Contact](#contact)
## Features
- **Simple and Clean UI**: A user-friendly interface that is easy to navigate.
- **Customizable Timers**: Set your own timer durations for different tasks.
- **Multiple Timer Modes**: Supports different timer modes such as countdown, stopwatch, and interval.
- **Notifications**: Get notified when the timer reaches zero, even when the app is in the background.
- **Dark Mode Support**: Automatically adapts to your device’s dark mode settings.
- **Sound Alerts**: Choose from a variety of sound alerts when the timer ends.
- **Pause and Resume**: Easily pause and resume the timer.
- **Flutter Local Notifications**: Integrates with local notifications for timely alerts.
- **Persistence**: Saves timer state across app restarts.
## Getting Started
### Prerequisites
Before you begin, ensure you have met the following requirements:
- **Flutter SDK**: Ensure you have Flutter installed on your machine. You can download it from the [official Flutter website](https://flutter.dev/docs/get-started/install).
- **Dart SDK**: Comes bundled with Flutter.
- **IDE**: Use an IDE such as [Android Studio](https://developer.android.com/studio) or [Visual Studio Code](https://code.visualstudio.com/) with the Flutter and Dart plugins installed.
- **Device/Emulator**: A physical device or emulator to run the app.
### Installation
1. **Clone the Repository**:
```
git clone https://[email protected]:Moniaar/pomtom.git
cd pomtom
```
2. **Install Dependencies**:
```
flutter pub get
```
3. **Run the App**:
```
flutter run
```
### Usage
Once the app is running, you can start by setting a timer using the intuitive UI. Choose your desired duration and mode (countdown, stopwatch, etc.), and hit the start button. You can pause, resume, or reset the timer as needed. If enabled, the purple side will fill up again and alert you when the timer reaches zero.
### Screenshots
Current app state:
Light-theme:
Dark-theme:
Initial goal (Final look for last version):
### Architecture
This Flutter Timer App follows a clean architecture pattern, separating concerns into different layers:
- Presentation Layer: Consists of the UI components, widgets, and state management.
- Domain Layer: Contains business logic and entities.
- Data Layer: Handles data persistence and retrieval.
The app uses the Provider package for state management and Flutter Local Notifications for notifications.
### Configuration
To customize the app further, you can modify the following configuration files:
lib/config/constants.dart: Contains constant values used across the app.
lib/config/themes.dart: Manages the theming of the app.
pubspec.yaml: Lists all dependencies and assets.
### Testing
The app includes unit tests and widget tests to ensure the functionality of various components:
- Unit Tests: Tests individual units of code such as functions or methods.
- Widget Tests: Tests UI components and their interactions.
To run the tests, use the following command:
```
flutter test
```
## Contributing
Contributions are welcome! If you’d like to contribute, please fork the repository and create a pull request. For major changes, please open an issue first to discuss what you would like to change.
1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request
### Checklist:
- Make the clock work in sync with the circle layout ✔️
- Make the user choose cutsom time to foucs with ✔️
- Enhance the timer UI --> Change "foucs timer" to Pomtom with unique font and add some plugins.
- Make the AI Actually work ✔️
- Remove the Settings button ✔️
- Add gradiant to the balls on main welcome page
- Enhance the Chatbot UI ✔️
- Add a welcome page to show up once when the user installs the app, it should be the logo and name of the App ✔️
- put a bar on the bottom of the app with 2 icons to navigate with ✔️
- The study buddy assistance on the 2nd page will be free for now, so make it work by any way you like
- A window that will ask you if you want to join the AI premium feature at first or not, once answered yes it won't appear again 🔜
- Do all this with the light theme as well ✔️
---
## Premium features functions (Future functionalities coming soon):
1. Study tracker
2. Full access to AI (For now it's free all time)
3. Payment methods
4. Multiple widgets for each section above
#### What I learned during the debugging phase:
- The debug console is your best friend when the app can't build when you run it.
- flutter pub get whenever you add an assest or a new dependcay or a plugin.
- Pubspec.yaml is very sensitive for identaion, you have to use your space not tab because it doesn't support it.
- Building wouldn't work without you fixing the pubspec.
- It's okay to add assets outside an assest folder (inside myapp folder which is the main one) if you have 2 or less. But once your assets are a lot, you will have to make a seprate folder for that.
The following is the tree structure of any basic flutter app:
A few resources to get you started if this is your first Flutter project:
**for fonts**:
- [Flutter fonts](https://docs.flutter.dev/cookbook/design/fonts#from-packages)
- [Google fonts](https://fonts.google.com)
- [Lab: Write your first Flutter app](https://docs.flutter.dev/get-started/codelab)
- [Cookbook: Useful Flutter samples](https://docs.flutter.dev/cookbook)
For help getting started with Flutter development, view the
[online documentation](https://docs.flutter.dev/), which offers tutorials,
samples, guidance on mobile development, and a full API reference.