To-do List Tool

To Do List Tool

📗 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
• 📝 License

📖 To-do List Project

To-do list is a tool that helps to organize your day. It simply lists the things that you need to do and allows you to mark them as complete. Built using ES6 and Webpack and inspired by the minimalist website.

🛠 Built With

• HTML
• CSS
• ES6
• Webpack

Tech Stack

Client

• HTML
• CSS
• ES6
• Webpack

Key Features

• Adding a new item.
• Removing a selected item.
• Marking a selected item as complete.
• Removing all items marked as complete at once.
• Reordering a selected item (as drag-and-drop) [as an additional feature].

(back to top)

🚀 Live Demo

• You can find the website here

(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:

• A Chrome browser
• Node
• npm

Setup

Clone this repository to your desired folder:

cd my-folder
git clone git@github.com:rmiyoyo/To-Do-List.git

Install

Install the prerequisites this project using:

cd To-Do-List
npm init -y
npm install --save-dev hint@7.x
npm install --save-dev stylelint@13.x stylelint-scss@3.xstylelint-config-standard@21.x stylelint-csstree-validator@1.x

Usage

To run the project:

npm start

Run tests

To run tests after setting up the linters, run the following command:

npx hint .

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

npx eslint .

Deployment

You can deploy this project using:

• Run index.html on your preferred browser.

(back to top)

👥 Authors

👤 Raphael Miyoyo

• GitHub: @rmiyoyo
• Twitter: @r_miyoyo
• LinkedIn: LinkedIn

(back to top)

🔭 Future Features

• Deploy to a live server

(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, create a pull request or hit us up on Twitter

(back to top)

🙏 Acknowledgments

• I appreciate you for having a look at my project! 💯

(back to top)

📝 License

• This project is MIT licensed.
  

(back to top)