/doable-todo-list-app

💡 An offline Flutter todo list app using Dart & ObjectBox Database with notification reminders & latest UI designs.

Primary LanguageDartMIT LicenseMIT


Logo

Doable Todo List App

💡 An offline Flutter todo list app using Dart & Hive Database with notification reminders & latest UI designs.

Explore the Documentations»
Report Bugs · Request Features

GitHub repo size GitHub contributors GitHub stars GitHub forks Twitter Follow






Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact
  8. Acknowledgments

About Doable: Todo List App



Doable is a Todo List App that makes your life well-organised and productive. It's easy-to-use UI and professional design makes Doeable the best Todo List App for you. Doable allows you to get more work done and arrange your scattered Todo List from your mind. More than just a Todo List, Doable is your key to:

  1. Enhanced personal productivity: Achieve more in less time and free up mental space for what truly matters.
  2. Reduced stress and anxiety: Gain control over your schedule and eliminate the burden of remembering countless tasks.
  3. A sense of accomplishment: Experience the satisfaction of checking off completed tasks and witnessing your progress.

Key Features:

  1. Seamless Task Management: Create, edit, and delete tasks with ease.
  2. Prioritize and Organize: Rearrange tasks to suit your workflow and mark them as completed for satisfaction.
  3. Never Miss a Deadline: Set notification reminders with specific dates and times, and receive handy notifications to keep you on track.
  4. Repeat for Consistency: Set tasks to repeat daily, weekly, or monthly for recurring activities.
  5. Find What You Need Fast: Utilize the built-in search function to quickly locate specific tasks within your list.

(back to top)

Built With Flutter

Flutter is an open source framework developed and supported by Google. App Developers use Flutter to build mobile apps for multiple platforms (iOS/android) with a single codebase.

(back to top)

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

Make sure you have git installed, type git --version in your cmd. (git official download page: https://git-scm.com/downloads)

git --version

Installation

Steps to install code and app into your local device (and run app on emulator or mobile device)

  1. Fork this repository (and leave a star if you like) by click on the fork button on the top right side.
  2. From your copy of this repo located yourname/doable-todo-list-app, copy the code link: https://github.com/your-user-name/doable-todo-list-app.git
  3. Create a folder named doable in your local device to store these files.
  4. Open terminal and type cd path/to/doable (replace /path/to/doable with the real path to the new doable folder we created in step 3)
cd path/to/doable

5. Clone your copy of this repo using `git clone link-you-copied-in-step-2` 
git clone https://github.com/your_username_/doable-todo-list-app.git

  1. Open the folder doable/doable-todo-list-app in your code editor (I use VS Code) & start coding.
  2. Run emulator or connect your mobile device with cable to run app on mobile.

(back to top)

Usage

For more examples, please refer to the Documentation_

(back to top)

Roadmap

  • Add task using button & swipe to delete task (taskId, taskName, description)
  • Add completion status: tick and untick (isCompleted)
  • Display tasks as ListView
  • Edit task on tap
  • Completed tasks go to bottom of ListView
  • Add time & date using cupertino_date_picker (dueDateTime)
  • Add repeat setting for daily, weekly and monthly (repeat)
  • Add notificaion reminder (reminder)
  • Delete completed tasks at 12:00 am daily
  • Add search bar using searchable_dropdown

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

How to get access to my project:

  1. Fork this repository (and leave a star if you like) by click on the fork button on the top right side.
  2. From your copy of this repo located yourname/doable-todo-list-app, copy the code link: https://github.com/your-user-name/doable-todo-list-app.git
  3. Create a folder named doable in your local device to store these files.
  4. Open terminal and type cd path/to/doable (replace /path/to/doable with the real path to the new doable folder we created in step 3)
cd path/to/doable

  1. Clone your copy of this repo using git clone [link you copied in step 2]
git clone https://github.com/your_username_/doable-todo-list-app.git

  1. Navigate to the root folder of this project
cd /path/to/doable-todo-list-app

  1. DO NOT MAKE CHANGES TO THE main BRANCH, create your own branch and name it your name
git branch my-user-name

  1. Confirm that your new branch my-user-name is created
git branch

  1. Select your new branch my-user-name and work on that branch only
git checkout my-user-name

  1. Confirm that you are in your branch my-user-name and NOT on main
git branch

Staying up-to-date with original code:

  1. You have to shift to main branch first but do NOT push to main branch
git checkout main

  1. Perform a pull to stay updated. It must show Already up-to-date
git pull

  1. Now you have to shift back to your branch my-user-name again before you can continue editing code
git checkout my-user-name

  1. Perform a pull again in my-user-name your own branch
git pull

Once you are ready to push the changes, follow these steps:

  1. Confirm you are in my-user-name your own branch
git branch

  1. Push the changes
git add .
git commit -m "issue #24 fixed"

  1. Choose git push origin HEAD, do NOT choose git push origin HEAD:master
git push
git push origin HEAD

(back to top)

License

Distributed under the MIT License. Click LICENSE.md for more information.

(back to top)

Contact

Akhin Abraham - twitter.com/akhinabr - theakhinabraham@gmail.com

Repository Link: https://github.com/theakhinabraham/doable-todo-list-app

(back to top)

Acknowledgments

Here are some resource links to help with this project and it's contribution:

(back to top)