kel-nana / review-to-do-list

To-Do List Project: A simple project build to add the todo tasks, check as completed and remove the task. This simple web page build using webpack, served by a webpack dev server, and test via Jest framework

To-Do List

Desktop view shoots for this project:

Desktop Veiw Representation

📗 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 simple project build to add the todo tasks, check as completed and remove the task. This simple web page build using webpack, served by a webpack dev server, and test via Jest framework.

🛠 Built With

Tech Stack

• Client
  • HTML
  • CSS
  • Webpack
  • Vanilla JavaScript
  • Jest Testing Framework

Key Features

• [Responsive layout]
• [UX/UI accessibility]
• [Dynamic data]

(back to top)

🚀 Live Demo

• Live Demo Link

(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 browser of you choice.
• A text editor of your choice.
• An installed node.js on your local system

Setup

Clone this repository to your desired folder:

• Use the following Commands:

  cd your-desired-folder
  git clone https://github.com/Kel-nana/Review-To-do-list.git
  

Install

• Install this project using following commands:

  npm init -y
  npm start
  npm test
  

Usage

• Use following commands to run on your local system:

  npm run build
  npm run dev
  

Run tests

• Run the following script and style test:

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

Deployment

• Add the following scripts to your jason file:

  "predeploy": "npm run build",
  "deploy": "gh-pages -d dist"
  

• You can deploy this project using:

  • Free deployment services like GitHub pages.
  • Any deployment services of your choice.

(back to top)

👥 Authors

👤 Abdul Ali Noori

• GitHub: @ab-noori
• Twitter: @AbdulAliNoori4
• LinkedIn: abdul-ali-noori

👤 Kelvin Irungu

• GitHub: @Kel-nana

👤 Bisaso Ronald

• GitHub: @bronnie313

🔭 Future Features

• [Add About page]
• [Add Contact page]

(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, give it a star.

(back to top)

🙏 Acknowledgments

I would like to thank Microverse and my coding partners, and also give credit to Traversy Media YouTub Channel, I really learned a lot from this channel.

(back to top)

❓ FAQ (OPTIONAL)

• How to make it mobile friendly?

  • Put a viewport tag in the header

• How to design the site?

  • Draw a mockup before start to code

(back to top)

📝 License

This project is MIT licensed.

(back to top)