ToDoList

ToDo List

📗 Table of Contents

• ToDoList
• 📗 Table of Contents
• 📖 [ToDo List]
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 🚀 Live Demo
  • 💻 Getting Started
    • Prerequisites
    • Setup
    • To run the project
    • To run the test
  • 👥 Authors
  • 🔭 Future Features
  • 🤝 Contributing
  • ⭐️ Show your support
  • 🙏 Acknowledgments
  • ❓ FAQ (OPTIONAL)
  • 📝 License

📖 [ToDo List]

[Here you can add your daily tasks list and check every task according to its completion. You can also remove and edit tasks. You can also clear all completed tasks after selecting them from the list. HTML/CSS and JavaScript best practices are used to make this project. Also used webpacks in this project. This project can be run on localhost.]

🛠 Built With

Tech Stack

Client

• HTML
• CSS
• JavaScript

Server

• N/A

Database

• N/A

Key Features

• [Displays List of ToDo Tasks]
• [Addition of New Tasks]
• [Removal of a Task from the list]
• [Local storage]
• [Editing a task with Edit Button]
• [Checkboxes are there to check the completed tasks]
• [All the completed tasks can be Cleared by Clicking the Clear All Completed Button]
• [A Reset button is also there to reset all the tasks.]
• [Webpack is managing all the dependencies and auto loading in browser]
• [All the scetions and functionality is re-created by ES6 Modules]
• [ToDo List is Interactive, checking and unchecking the checkbox is interactive.]

(back to top)

🚀 Live Demo

• My ToDoList Project's Live Demo Link

(back to top)

💻 Getting Started

• Install VS Code and run it on Live Server if you want to check how the code works on local host.

Prerequisites

In order to run this project you need:

1. Browser.
2. VS Code editor
3. Git and GitHub
4. Webpack Setup

Setup

Clone this repository to your desired folder:

  cd my-folder
  git clone [email protected]:Mike111222/ToDoList.git

To run the project

Open index.html file in VS Code, run via live server extension and see how the code works. You can also visit the Live Demo Link to see how the Project works online.

To run the test

Make sure you are in the project folder

• Make sure you have node.js installed
• npm installed
• npm i -D jest
• change your your test script to jest (optional: --coverage)
• Run npm test

(back to top)

Use index.html file.

👥 Authors

👤 Muhammad Amran Khan [Mike]

• GitHub: @githubhandle
• LinkedIn: LinkedIn
• Twitter: @twitterhandle

(back to top)

🔭 Future Features

• [Navigation bar]

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

If you like this project, just reach out to me for more projects even better than this, and please give it a star ⭐️.

(back to top)

🙏 Acknowledgments

I would like to thank my fellow Authors, my friend, my code reviewers and Microverse.

(back to top)

❓ FAQ (OPTIONAL)

• [How can the project be improved]

  • [More features can be intergrated by adding more pages for example pending tasks from the past]

• [Can I use this project for study purposes]

  • [Yes]

(back to top)

📝 License

This project is MIT licensed.

(back to top)