/todo-list-webpack

An application to track down your todo tasks. Create a list of the tasks you have to do, edit any task description you wish to, finish a task and mark it as complete or clear all the tasks that have been completed. Tasks are stored in the local storage.

Primary LanguageJavaScriptMIT LicenseMIT

TODO LIST README

📗 Table of Contents

📖 TODO LIST

**TODO LIST ** is a simple todo list that keeps track of an individuals tasks. A user can add a task, edit or even delete it. When the task is completed, user is able to mark is as complete. The tasks are sorted using their indices.

🛠 Built With

Tech Stack

Client
  • Javascript
  • HTML/CSS
  • Webpack
Server
  • N/A
Database
  • N/A

Key Features

  • Add a todo task
  • Edit or delete your todo task
  • Mark your task as completed

Screenshot

(back to top)

🚀 Live Demo

(back to top)

💻 Getting Started

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

Prerequisites

In order to run this project you need:

  • NodeJS installed
  • Text Editor preferably VS Code

Setup

Clone this repository to your desired folder:

  mkdir todo-list
  cd todo-list
  git clone https://github.com/inspecta/todo-list-webpack.git

Install

Install this project with:

  cd todo-list-webpack
  npm install

Usage

To run the project, execute the following command:

  npm start

Run tests

To run linter tests, run the following command:

  npx eslint .
  npx hint .
  npx stylelint "**/*.{css,scss}"

Deployment

You can deploy this project using:

  • GitHub pages
  • Netlify

(back to top)

👥 Authors

👤 DERRICK MULINDE

(back to top)

🔭 Future Features

  • A user authentication functionality
  • A backend to store these tasks permannently
  • A time functionality to remind the user of when to perform a task

(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, go ahead and give it a star. It is very much appreciated.

(back to top)

🙏 Acknowledgments

I would like to thank Microverse for providing me with the reading material that helped me during this project development.

(back to top)

❓ FAQ (OPTIONAL)

  • Can I reuse this projects' code?

    • Yes, it is okay.

  • Can I contribute to this repository?

    • Yes. Just contact me at djmulinde@gmail.com and I will gladly add you as a contributor to the repository.

(back to top)

📝 License

This project is MIT licensed.