Todo App

A simple Flutter application for managing todos with CRUD operations.

Table of Contents

• Introduction
• Features
• Getting Started
  • Prerequisites
  • Installation
• Project Structure

Introduction

Welcome to the Todo App! This Flutter application allows users to create, read, update, and delete todo items. The focus is on providing an intuitive and visually appealing interface for managing tasks efficiently.

Features

• List all todos
• Create a new todo
• Update an existing todo
• Delete a todo
• Optimistic UI updates for a smoother user experience

Getting Started

Prerequisites

Make sure you have Flutter and Dart installed on your machine. If not, follow the official Flutter installation guide.

Installation

1. Clone the repository:

   git clone https://github.com/karar0120/todo-app-flutter.git
   cd todo-app-flutter

2. Install dependencies:

   flutter pub get

3. Run the app:

   flutter run

Project Structure

.
├── core                       # For all common and core files.
│   ├── error                  # contains all Exceptions and Failures classes
│   ├── presentation           # Common presentation files
|   │   └── blocs              # Common blocs
|   │   └── pages              # Core pages
|   │   └── widgets            # Common widgets
│   └── route                  # Routes for navigation
│   └── theme                  # Theme data
│   └── usecases               # Common usecases
|
├── data                       # Data Files of Feature 1
│   ├── datasources            # DataSources Abstract Files and Implementations
│   │   └── feature            # Feature 1 (for exp : Todo Feature)
│   │       └── sub-feat.      # Sub feature
│   ├── models                 # Models for data
│   │   └── feature            # Feature 1 (for exp : Todo Feature)
│   │       └── sub-feat.      # Sub feature
│   └── repositories           # Repositories Implementation Classes
│       └── feature            # Feature 1 (for exp : Todo Feature)
│           └── sub-feat.      # Sub feature
├── domain                     # Domain
│   ├── entities               # Entities For Feature 1
│   │   └── feature            # Feature 1 (for exp : Todo Feature)
│   │       └── sub-feat.      # Sub feature
│   ├── usecases               # Usecases of Feature 1
│   │   └── feature            # Feature 1 (for exp : Todo Feature)
│   │       └── sub-feat.      # Sub feature
│   └── repositories           # Repositories Abstract Classes
│       └── feature            # Feature 1 (for exp : Todo Feature)
│           └── sub-feat.      # Sub feature
└── presentation               # Presentation files
    ├── blocs                  # Blocs
    │   └── feature            # Feature 1 (for exp : Todo Feature)
    │       └── sub-feat.      # Sub feature
    ├── pages                  # Pages
    │   └── feature            # Feature 1 (for exp : Todo Feature)
    │       └── sub-feat.      # Sub feature
    └── widgets                # Widgets
        └── feature            # Feature 1 (for exp : Todo Feature)
            └── sub-feat.      # Sub feature

Architecture

This app uses [Clean Architecture by Robert C Martin]

Image Source : ResoCoder

Branches

.
├── master                       # Contains the latest release
       ├── dev                   # Contains the latest development
            ├── feature1         # feature 1 created from dev
            ├── feature2         # feature 2 created from dev
            ├── feature3         # feature 3 created from dev
            ├── bugFix1          # bugfix 1 created from dev
            ├── bugFix2          # bugfix 1 created from dev
            ├── docChange1       # docChange 1 created from dev
            ├── docChange1       # docChange 2 created from dev

📱 Screens

🏠 All Todos

• Used caching mechanism to store and retreive data from local storage.

➕ Add Todo

• Validation data in all text form field.

🔨 Edit Todo

❎ Delete Todo

• Add confirmation message to check need to delete or not

• Show a confirmation pop up to display successful message after add , edit ,delete