Microverse README

📗 Table of Contents

• 📗 Table of Contents
• 📖 To Do List App
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 🚀 Live Demo
  • 💻 Getting Started
    • Prerequisites
    • Setup
    • Install
    • Run tests
    • Deployment
  • Author
  • 🔭 Future Features
  • 🤝 Contributing
  • ⭐️ Show your support
  • 🙏 Acknowledgments
  • ❓ FAQ
  • 📝 License

📖 To Do List App

A tool that helps to organize your day. It simply lists the things that you need to do and allows you to mark them as complete.

🛠 Built With

Tech Stack

Key Features

• Adding a new item
• Removing a selected item
• Marking a selected item as complete
• Removing all items marked as complete at once
• Reordering a selected item (as drag-and-drop)

(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 PC running any operating system like Windows, Linux, or MacOS
• An Internet connection
• Knowledge of some basic Git commands
• A browser like Microsoft Edge, Google Chrome or Mozilla Firefox
• Git installed
• Webpack installed

Setup

• Link your PC to GitHub
• Clone this repository to your desired folder:

git clone https://github.com/miltonHenschel/ToDoList-App.git

cd ToDoList-App

• Open the file in your code editor

code .

• Setup JavaScript + CSS + HTML linter

Run the following codes in your project folder in your IDE:

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

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

Install

Install this project with:

• node_modules

npm install -g node-modules

• webpack

npm install -g webpack

npm install -g webpack-cli

• project dependencies

npm install

Usage

Start the server

npm run start

Run tests

To run Stylelint and ESLint tests, run the following commands respectively:

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

npx eslint .

Deployment

To deploy this project run

npm run deploy

(back to top)

Author

👥 Henschel Nketchogue M.

• GitHub: miltonHenschel
• LinkedIn: henschelnketchoguem
• Twitter: nketchogue
• Instagram: mpatchiehenschel

(back to top)

🔭 Future Features

• Improve design

(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

• 

(back to top)

❓ FAQ

• How to fix JavaScript + CSS + HTML linter errors?

  • Kindly use the following in your project's root directory:

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

  npx eslint . --fix
  

(back to top)

📝 License

This project is MIT licensed.

(back to top)