📗 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

📖 Todo List

Todo List is a simple to-do application that allows you to save your tasks and keep track of them right in your browser. The tasks are stored in your browser's local storage, so you can access them whenever you need to, even if you are offline. With Todo List, you can add new tasks, mark them as completed, and easily keep track of everything you need to do. Give it a try and never forget a task again!

🛠 Built With

Tech Stack

• JavaScript
• HTML
• SCSS
• Webpack
• Jest

Key Features

• Save your tasks and keep track of them right in your browser.
• Edit tasks.
• Mark tasks as completed.

(back to top)

🚀 Live Demo

• Open 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 to install Nodejs

Setup

Clone this repository to your desired folder:

  cd my-folder
  git clone git@github.com:Kweeka1/to-do-list.git

Install

Install dependencies with:

  cd to-do-list
  npm install

Usage

To run the project, execute the following command:

  npm run start

Run tests

To run tests, run the following command:

  npm run test

Deployment

You can deploy this project using npm library called gh-pages:

• First install the library

npm install gh-pages --save-dev

• Then follow the instructions provided in their readme file to deploy the app

GH Pages README

(back to top)

👥 Authors

👤 Mohamed Talbi

• GitHub: Mohamed Talbi

👤 Robert Alabi

• GitHub: Robert Alabi

(back to top)

🔭 Future Features

• Improve user interface
• Save tasks in a database
• Add notification feature

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

Put a star if you like this project.

(back to top)

🙏 Acknowledgments

I would like to thank Microverse for project inspiration.

(back to top)

❓ FAQ (OPTIONAL)

• What version of nodejs does this project work on ?

  • any version above 12

(back to top)

📝 License

This project is MIT licensed.

(back to top)