todo_app

ToDo App

---

Manage your daily activities and get notified with ToDo App.

📄 Table of contents

• 🧐 About
• 🏁 Getting Started
• 🚀 App features
• 📂 Files/Folders structure and Build app
• 🎨 App Design

🧐 About

ToDo App is an Android app made with flutter to create and remind tasks and todos in our daily lives. The app is designed based on a better user interface and user experience. It also implemented animations for better user satisfaction. In this app, you can create tasks or todos for a particular time, and the app will remind you in time. It also allows you to edit and categorize your todos for better management. You can also select colors for your categories. You can also search todos based on the search key or category name. It has 6 languages available (English, Arabic, French, Spanish, Chinese, and Malayalam). The user will have a profile with a name and an image. No internet connection is needed.

🏁 Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

What things do you need to install the software and how to install them?

1. Dart SDK
2. Flutter SDK
3. Java Development Kit

Run the following command to see if there are any platform dependencies you need to complete the setup:

flutter doctor

🚀 App features

• Create, edit and delete todo/task.
• Cool UI & UX
• Animated splash screen
• Categorize each todo
• Unlimited todos/tasks
• Remind you in time for doing the task
• Mark your todo as completed
• Select the color for your category
• Change the language of the app (English, Arabic, French, Spanish, Chinese, and Malayalam)
• Create a user profile with an image and name
• Search todos by query or category
• Edit user profile image and user name
• No internet connection is needed.
• 8 Screens (Home, Splash, View categories, Add todo, - Edit todo, login, Search, Settings)
• Erase all data
• Clear app data

📂 Files/Folders structure and Build app

• lib folder (source code of the app):-

  ‘lib’ folder contains the source code of dart/flutter for building the app. Inside the lib folder code is structured into sub-folders and files for better readability, editability, and standard.

  • main.dart file:- starting of the app.

  • Assets: Static assets for the app.

    This directory is on the root level and will contain all the static assets that are used in the application, for example, fonts, icons, logos, background images, demo videos, etc.

  • Screens: Screen /UI of the app.

    This directory will contain the actual layout of the UI for the entire application.

  • Providers: Data state of the app.

    This directory is supposed to hold all the interactions that transact the data in the app.

  • Widgets: Widgets / Layouts used in the app.

    It becomes clear all by the name itself that this folder will hold all the static widgets or the widgets that are used multiple times in the application.

  • Utils: Utilities used in the app

    This folder contains the utility features of the app like translation data or logic.

  • Helpers: Helpers used in the app

    This folder contains the functionalities like computing some data to another or doing some things, for example, checki if a time is past or future.

  • Constants: constant value

    This folder holds the constant values in the app that will never change.

• build folder:-

  Build outputs folder of flutter projects. The build release or debug apps appear here after the build command is run. Currently, you can find the android build files such as apk files here. You can take a build by running the command flutter build apk --split-per-abi. It will generate the app supporting architectures

  • build/app/outputs/apk/release/app-armeabi-v7a-release.apk
  • build/app/outputs/apk/release/app-arm64-v8a-release.apk
  • build/app/outputs/apk/release/app-x86_64-release.apk

  or you can generate the app that supports all of these architectures by typing the command flutter build apk --release, but note that the size of the app will increase a bit. For more details about flutter android deployment, you can find here.

• android folder:-

  android configuration files.

• ios folder:-

  ios configuration files.

• test folder:-

  app testing files.

• web folder:-

  web configuration files.

🎨 App Design

App design files includes in assets\design folder.

---

Documentation created by Rahif on 03-08-2022.