Skip to content

altafparves/todo-list

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

69 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation


Todo List

A simple and intuitive todo list application designed for efficient task management. It offers features like filtering, priority levels, due dates, and status tracking to help you stay organized.

View Demo

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Contributing
  5. Contact

About The Project

image

This Todo List app is designed to be user-friendly and efficient, helping you manage your tasks effectively. Key features include:

  • Task Filtering: Quickly filter tasks by "Today," "Completed," "All," or "Important."
  • Priority Levels: Assign priority levels (e.g., Low, Medium, High) to your tasks.
  • Due Dates: Set due dates for tasks to keep track of deadlines.
  • Status Tracking: Monitor the progress of your tasks with status updates (e.g., Not Started, In Progress, Done).
  • Intuitive Interface: A clean and modern UI for easy navigation and task management.

Built With

  • React
  • Redux
  • Tailwind
  • Framer Motion

Getting Started

To get a local copy up and running, follow these steps:

Prerequisites

  • Node.js (v16 or higher recommended)
  • npm (or yarn)

Installation

  1. Clone the repository:
    git clone [https://github.com/github_username/repo_name.git](https://github.com/github_username/repo_name.git)
  2. Navigate to the project directory:
    cd repo_name
  3. Install dependencies:
    npm install  # or yarn install
  4. Start the development server:
    npm start # or yarn start

Usage

This section provides a guide on how to use the Todo List application effectively.

  1. Creating a Task:

    • In the "Create a new Task" field, simply type in the description of your task.
    • Click the "Create +" button to add the task to your list.
  2. Viewing and Managing Tasks:

    • Tasks are displayed in the main list area.
    • Each task shows its description, due date (if set), priority level, and status.
  3. Editing a Task:

    • Click on a task in the list to open the task details for editing.
    • You can:
      • Rename the task directly in the description field.
      • Add or modify the description.
      • Set or change the due date using the date dropdown.
      • Set or change the priority level using the priority dropdown (e.g., Low, Medium, High).
      • Change the task status using the status dropdown (e.g., Not Started, In Progress, Done).
  4. Marking a Task as Done:

    • To mark a task as completed, simply check the box located next to the task.
  5. Menu

    • Use the menu in sidebar to see different views:
      • All: Shows all tasks.
      • Today: Shows tasks due today.
      • High Priority: Shows tasks with high priority.
      • Completed: Shows tasks that have been marked as complete.
  6. Filter

    • Click filter button and click again the filter options:
      • Due Date
      • Priority Scale
      • Completion Status
      • Completed:

Contributing

Contributions are welcome! If you'd like to contribute to this project, please follow these steps:

  1. Fork the repository.
  2. Create a new branch for your feature or bug fix.
  3. Make your changes.
  4. Commit your changes and push them to your branch.
  5. Submit a pull request.

Contact

Altaf Parves - @shuaaltaf - altafparvesh@gmail.com

Project Link: https://github.com/altafparves/todo-list

(back to top)

About

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published