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
• 📝 License

📖 [About the Project - To Do List: Set Structure.]

to_do_list It’s a minimalistic & dynamic To Do List web app! This is a project branch for setting up the structure of the To Do List web app.

🛠️ Built With

Tech Stack

• HTML
• CSS
• JAVASCRIPT
• WEBPACK

Key Features

• Good HTML and CSS practices
• A webpage with the use of linters
• Dynamic interactivity with JavaScript
• Project bundled with Webpack

(back to top)

Live Demo

🚀 Live Demo Link to our deployed project (project is not deployed yet).

• https://

💻 Getting Started

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

Prerequisites

In order to run this project you need the following tools:

• A modern web browser (Chrome, Firefox, Safari, Edge).
• An IDE (e.g.: Vscode, Sublime Text,…).
• A terminal (Git Bash).
• Install and use Webpack project bundler.

Setup

Clone this repository to your desired folder by running the following commands in your terminal:

  cd your-prefered-folder-name
  
  git clone git@github.com:78fatemanazari/To-Do-List.git

Install

• Install this project with linters and Webpack bundler:

  cd to_do_list

  npm init -y

  npm install --save-dev hint@7.x

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

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

  install & configure Webpack bundler with npm, lodash, an HTMLWebpack plugin
  and a Webpack-dev-server

Usage

To run the project, execute the following command:

  Open the project in Webpack dev server or Open the index.html file, from dist/ folder, on your browser.

Build the project with Webpack and run a dev server

  Run the following commands in the terminal:

  npm run build
  
  npm start

Run Linters tests

To run tests, run the following command:

  npx hint . --fix
  
  npx stylelint "**/*.{css,scss}" --fix

  npx eslint . --fix

👥 Authors

👤 Fatema Nazari

• GitHub: @78fatemanazari
• Twitter: @fati_nazari78
• LinkedIn: 78fatemanazari

(back to top)

🔭 Future Features

The To Do List website will offer the following features:

• Data storage in the browser’s local storage
• CRUD task operations (Create, Read, Update, Delete)
• Updating & removing completed tasks
• Reorder data array after deleting tasks

(back to top)

🤝 Contributing

All 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, please support me with a like or a star.

(back to top)

🙏 Acknowledgments

• Thanks to my learning partners.
• Thanks to the Microverse team for the great curriculum.
• Thanks to the Code Reviewer(s) for the insightful feedbacks.

(back to top)

📝 License

This project is MIT licensed.

(back to top)

This site is open source. Improve this page.