Donmark2k/todo_list

A To-do list app helps us to list everything that we have to do. It is helpful in planning our daily schedules along with the option to remove the completed tasks. Built with, HTML, CSS, JavaScript and Webpack.

Microverse README Template

📗 Table of Contents

• 📖 About the Project
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 🚀 Live Demo
• 💻 Getting Started
  • Setup
  • Prerequisites
  • Install
  • Usage
  • Run tests
  • Deployment
• 👥 Authors
• 🔭 Future Features
• 🤝 Contributing
• ⭐️ Show your support
• 🙏 Acknowledgements
• ❓ FAQ (OPTIONAL)
• 📝 License

📖 [To do list]

[To do list] is used to display and remind us of what we have to do and equally delete the completed task.

🛠 Built With

Client

• HTML
• CSS
• JavaScript

Database

• LocalStorage

Key Features

• [I use webpack to bundle JavaScript]
• [I create a new JavaScript file for the new functionality.]
• [I implement a function for adding a new task (add a new element to the array).]
• [I implement a function for deleting a task (remove an element from the array).]
• [I implement a function for editing task descriptions.]
• [I added an event listener to the checkbox (change).]
• [I implement a function to update items object's value for completed key upon user actions]
• [I implement a function for the "Clear all completed" button using (use filter() method)]

(back to top)

🚀 Live Demo

Add a link to your deployed project.

• Live Demo Link

(back to top)

💻 Getting Started

Describe how a new developer could make use of your project.

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

Prerequisites

• In order to run this project you need:

• git: A tool for managing source code

• Visual Studio Code: A source code editor

• Live Server: A simple web server utility for Visual Studio Code

Setup

Clone this repository to your desired folder: https://github.com/Donmark2k/todo_list.git

Example commands:

  cd my-folder
  git clone git@github.com:myaccount/my-project.git

Install

Install this project with:

• cd my-folder
• git clone https://github.com/Donmark2k/todo_list.git

install npx

Example command:

  cd my-project
  npx install

--->

Usage

To run the project, execute the following command:

• Open the cloned folder on the VS code
• Open the live server

Run tests

To run tests, run the following command:

• To check for stylelint errors, run npx stylelint "**/*.css{css,scss}".
• To check for javascript error, run npx eslint .

Deployment

You can deploy this project using:

• Github pages

Github pages

follow these steps for example

👥 Authors

Mention all of the collaborators of this project.

👤Chukwuemeka Ochuba

• GitHub: @Donmark2k
• Twitter: @Donmark2k
• LinkedIn: LinkedIn

(back to top)

🔭 Future Features

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

Victor Chiemerie and Grace Htet has been of tremendous help so far.

(back to top)

🙏 Acknowledgments

I would like to appreciate Microverse for providing the resources and the platform for us to be a Professional full-stack developer.

(back to top)

❓ FAQ (OPTIONAL)

Add at least 2 questions new developers would ask when they decide to use your project.

• [Are you sure that you are owner of this work]

  • [Yes, I am]

  • [Can you make the website responsive]

  • [Yes]

(back to top)

📝 License

This project is MIT licensed.

(back to top)