Table of Contents

• Table of Contents
• [To-Do List]
  • Built With
    • Tech Stack
    • Key Features
  • Live Demo
  • Getting Started
    • Prerequisites
    • Configuring WebPack
    • Setup
    • Install
    • Usage
    • Run tests
    • Deployment
  • Authors
  • Future Features
  • Contributing
  • Show your support
  • Acknowledgments
  • License

[To-Do List]

[To-Do List] is my first Capstone project that mimics a real-world project.

Built With

1. HTML
2. CSS
3. BootStrap
4. JavaScript
5. WebPack
6. LightHouse
7. WebHint
8. Styelint
9. ESLint
10. Git
11. Github

Tech Stack

Key Features

• [Add New Task]
• [See All Tasks]
• [Simple Design]
• [Responsive]
• [Good look and feel]

Live Demo

• You can see the live demo of this webpage by clicking here;

Getting Started

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

1. Download or clone this repostory.
2. Provide a browser.
3. Open the ./dist/index.html file using webpage browser.

Prerequisites

In order to run this project you need:

• Git installed in your machine.
• Sign in or sign up to your Github account.
• A professional editer such as VS Code.
• An Updated web browser such as Google Chrome, you can download it from here.
• Node.js installed in your machine.
• Lighthouse.
• Webhint
• Stylelint
• ESLint
• WebPack

npm init -y
npm install --save-dev [email protected]
npx hint .

• Stylelint

npm install --save-dev [email protected] [email protected] [email protected] [email protected]

• ESLint

npm install --save-dev [email protected] [email protected] [email protected] [email protected]

Configuring WebPack

1. Initialize package.json:

npm init y

2. Install webpack:

npm install webpack webpack-cli --save-dev

3. Install CSS style loader:

npm install --save-dev style-loader css-loader

Setup

• Clone this repository to your desired folder:

• Example commands:

  cd [YOUR FOLDER]
  git clone https://github.com/M-Anwar-Hussaini/To-Do-List.git

Install

• Install this project by cloning or downloading the master branch of this repository and run index.html file on the root of repository.

Usage

• To run the project, execute the following command:

 cd [YOUR FOLDER]
 git clone https://github.com/M-Anwar-Hussaini/To-Do-List.git

Run tests

1. WebHint

npx hint .

2. Stylelint

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

3. ESLint

npx eslint .

Deployment

This project is deployed by the author, no permission for deployment by any other client.

Authors

Mohammad Anwar Hussaini (Main Author)

• GitHub: @Anwar Hussaini
• Twitter: @MAnwarHussaini
• LinkedIn: Mohammad Anwar Hussaini

Future Features

• [Add New Task dynamically]
• [Local Storage Usage]
• [Manipulate Tasks]

Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

Show your support

If you like this project, kindly drop a start for the repository;

Acknowledgments

I would like to thank the following individuals and organizations for their contribution to this project.

• Microvere for its arrangement and supports to all Micronauts and me.
• IonIcon for its free flexable icons.
• Bootstrap Bootstrap for its invaluable framework that greatly enhanced this project.
• Hafizullah Rasa for his instructions on cinfiguring the WebPack (@hafiz1379).

License

This project is MIT licensed.