to-do-list

To do list

📗 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 a website to manage your daily tasks

🛠 Built With

Tech Stack

The following stacks were used

• HTML
• CSS
• Javascript
• Webpack

Key Features

Not yet published

• Add a book
• Remove a book

(back to top)

🚀 Live Demo

Coming soon

(back to top)

💻 Getting Started

Prerequisites

In order to run this project you need to have a browser and of course a code editor

Run the following command

Setup

Clone this repository to your desired folder, you can also set up HTML, CSS and JavaScript linters, for this you will need node installed. you can follow the steps here to setup the linters

Install

Once you cloned this project run the following in your terminal

 npm install

 npm start

Usage

To run the project, you can simply type the link http://localhost:8080/ on your favorite browser.

Run tests

If you follow the tutorial above to setup linters then you can run these tests

  npx hint .

  npx stylelint "**/*.scss"

or if you use css then run this instead of the latter command above

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

  npx eslint .

Deployment

Not yet deployed

(back to top)

👥 Authors

👤 Gueleu S. Farida

• GitHub: @SFarida
• Twitter: @First_Dialo
• LinkedIn: LinkedIn

(back to top)

🔭 Future Features

Describe 1 - 3 features you will add to the project.

• Displays a list of your tasks
• Option to clear completed tasks
• Option to add a new task
• Option to delete 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 you can follow me on github for more.

(back to top)

🙏 Acknowledgments

thanks to Microverse for providing the necessary resources.

(back to top)

❓ FAQ (OPTIONAL)

• Are the linters necessary?

  • It is a good practice to install and use them as they guide you towards best practice, but yes you can do without.

(back to top)

📝 License

This project is MIT licensed.

(back to top)