:green_book: Table of Contents

• :book: About the Project
  • 🛠 Built With
  • Tech Stack
  • Key Features
  • :rocket: Live Demo
• :computer: Getting Started
  • Prerequisites
  • Setup
  • Install
  • Usage
  • Run tests
  • Deployment
• :bust_in_silhouette: Author
• :telescope: Future Features
• :handshake: Contributing
• :star:️ Show your support
• :pray: Acknowledgements
• :memo: License

To-do list Project

To-Do List Project is the project build with webpack and Javascript.It is a simple website for adding and removing to-do list. Here we used HTML, CSS to design site and used Javascript for dynamic functionality. also we used webpack for bundling the project.

🛠 Built With

Tech Stack

Key Features

• Using webpack
• Local Storage
• JavaScipt ES6
• Dynamics of HTML using JavaScript
• DOM Elements

(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 web browser to view output e.g Google Chrome.
• An IDE e.g Visual studio code.
• A terminal.

Setup

Clone this repository to your desired folder or download the Zip folder:

    "git clone https://github.com/mahdinoori2000/to-do-list.git"

• Navigate to the location of the folder in your machine:

    cd ./user/

Install

Install all dependencies:

    "npm install"

Usage

To run the project, follow these instructions:

• write the following command.

     "npm start"

Run tests

To run tests, run the following command:

• HTML linter errors run:

npx hint .

• CSS linter errors run:

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

• JavaScript linter errors run:

npx eslint .

• For unit testing, run:

npm test

Deployment

You can deploy this project using: GitHub Pages,

• I used GitHub Pages to deploy my website.
• For more information about publishing sources, see "About GitHub pages".

(back to top)

Author : Mahdi Noori

• GitHub: @mahdinoori2000
• Twitter: @mahdinoori2000
• LinkedIn: Mahdi Noori

(back to top)

Future Features

• [ ] Add add book functionality
• [ ] Add remove book functionality

(back to top)

Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

Show your support

Give a ⭐ if you like this project.

(back to top)

Acknowledgments

• I want to thank microverse for providing the design and requirements for this project.

(back to top)

License

This project is MIT licensed.

(back to top)