todo-list

My Microverse todo-list project (Module two)

📗 Table of Contents

• [📖 🎯 todo-list
  • 🛠 Built With
    • Tech Stack
  • 🚀 Live Demo
  • 👁 Presentation
  • Deploy my website with github pages":
  • - Loom video link:
  • 💻 Getting Started
    • Prerequisites
    • Install
  • Requirements
    • Run tests
    • Deployment
  • 👥 Authors
  • 🔭 Future Features
  • 🤝 Contributing
  • 👋 Show your support
  • 🔭Acknowledgments
  • 📝 License

📖 To Do List

To Do List is a web page where the user can see a list of todos, they can also add or remove any todo to the list.

🛠 Built With

Technology

• HTML
• CSS
• Javascript
• Webpack
• Linters (Lighthouse, Webhint, Stylelint, Eslint)
• Git/GitHub work-flow

(back to top)

Tech Stack

Client

• JavaScript

• Html

• CSS

Server

• N/A

Database

• LocalStorage

🚀 Live Demo

• Live Demo Link

(back to top)

👁 Presentation

• Loom presentation Link

Deploy my website with github pages"

link to todo-list:

- Loom video link

Loom walking through for my-awesome-books:

💻 Getting Started

To get a local copy up and running follow these simple example steps.

Prerequisites

• IDE to edit and run the code (We use Visual Studio Code 🔥).
• Git to versionning your work.

Install

• first install package.json and node_modules run: npm init -y

• npm install --save-dev hint

• npm install --save-dev stylelint@13.x stylelint-scss@3.x stylelint-config-standard@21.x stylelint-csstree-validator@1.x

or latest version:

• npm install --save-dev stylelint stylelint-scss stylelint-config-standard stylelint-csstree-validator

• npm install --save-dev eslint@7.x eslint-config-airbnb-base@14.x eslint-plugin-import@2.x babel-eslint@10.x

or latest version:

• npm install --save-dev eslint eslint-config-airbnb-base eslint-plugin-import babel-eslint

Requirements

• Linters configuration.

Clone the repository to get start with project, then make sure to install dependencies in the linters file located in the linter file

(back to top)

Run tests

• to test and check the html file/s is error-free run: npx hint .

• to fix errors run: npx hint . -f

• to test and check the css file/s is error-free run: npx stylelint "**/*.{css,scss}"

• to fix errors run: npx stylelint "**/*.{css,scss}" --fix

• to test and check the js file/s is error-free run: npx eslint .

• to fix errors run: npx eslint . --fix

Deployment

Check for the tests when you generate a pull request and fix the errors if any. For stylelint error run: sudo npx stylelint "*/.{css,scss}" --fix and it will the fix style issues automatically.

👥 Authors

👤 Mohamed Gamil Eldimardash

• GitHub: @github
• LinkedIn: LinkedIn
• Twitter: twitter
• Facebook: facebook

🔭 Future Features

• Add local storage to save todos

• Add functionality to add and remove todos

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page

👋 Show your support

Give a ⭐️ if you like this project!

(back to top)

🙏 Acknowledgments

• Microverse Team.

I would like to thank Microverse for the information provided to build this project.

(back to top)

❓ FAQ (OPTIONAL)

• Can I use the project for any purpose?

  • Yes, you can use this files for anything you need.

• Is the information saved in any database?

  • No, all data is saved in Local Storage.

📝 License

This project is MIT licensed.

(back to top)