📗 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

📖 [Todo List]

A simple application to keep track of activities

🛠 Built With

• HTML
• JS
• CSS

Tech Stack N/A

Client

• N/A

Server

• N/A

Database

• N/A

Key Feature

• Displays list of todos and indicates weather complete or not with line strike through

(back to top)

🚀 Live Demo

• GitHub Pages:

• https://shafiuyushawu.github.io/Todo-List/dist/

(back to top)

(back to top)

💻 Getting Started

To get the content of this project locally you need to run the following commands in your terminal.

Prerequisites

• IDE (code editor) like: VScode, Sublime, etc
• Git

Setup

1. Download the Zip file or clone the repo with:

git clone https://github.com/shafiuyushawu/Todo-List

2. To access cloned directory run:

cd Todo List

Install

To install linters and other project's dependencies run:

npm install

Usage

To run the project, execute the following command:

• Excute below command in the terminal to serve live

npm run dev

Run Test for Linters

For tracking linter errors locally you need to follow these steps:

1. For tracking linter errors in HTML files run:

npx hint .

2. For tracking linter errors in CSS or SASS files run:

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

3. For tracking linter errors in JavaScript files run:

npx eslint .

Deployment

You can deploy this project using:

• N/A

(back to top)

👥 Author: Shafiu Ibn Yushawu

👤 Authors

• GitHub: @shafiuyushawu,
• Twitter: @shafiuyushawu

(back to top)

🔭 Future Features

• Implement input for users to add todso.
• Create a function to receive user interaction to strike through todos.

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Kindly raise issue here

(back to top)

⭐️ Show your support

If you like this project, kindly follow me on GitHub 😊

(back to top)

🙏 Acknowledgments

• N/A

(back to top)

📝 License

This project is MIT licensed.

(back to top)