Microverse README Template

📗 Table of Contents

• 📖 About the Project
  • 🛠 Built With
    • Tech Stack
    • Key Features
• 💻 Getting Started
  • Setup
  • Prerequisites
  • Install
  • Usage
  • Run tests
  • Deployment
• 👥 Authors
• 🔭 Future Features
• 🤝 Contributing
• ⭐️ Show your support
• 🙏 Acknowledgements
• 📝 License

📖 [To do list with javascript]

[ Todo list project ] is a project that shows the use of webpack to bundle JavaScript, proper use of ES6 syntax and ES6 modules to write modular JavaScriptand remove books using ES6. It allows a user to add, edit or remove items from the local storage of the browser.

🛠 Built With

• Javascript
• Html5
• CSS
• Webpack

Client

• Javascript
• HTML5
• CSS

Key Features

Describe between 1-3 key features of the application.

• [HTML5]
• [Javascript]
• [CSS]

(back to top)

🚀 Live Demo

Add a link to your deployed project.

• Live Demo Link

(back to top)

💻 Getting Started

• Create a local directory to clone this repository.

• Open the command prompt in the created directory.

• On the terminal run this command git clone https://github.com/teitonny/Todo-List-v2.git

• Install the dev dependencies for linters and run npm install. npm i --save-dev webpack --config webpack.config.js webpack-cli webpack-dev-server express webpack-dev-middleware style-loader css-loader html-webpack-plugin mini-css-extract-plugin loadash

Prerequisites

In order to run this project you need:

• To install Git

• VS Code or other IDEs

• A browser

Setup

Clone this repository to your desired folder:

Install

Install this project with:

• git

Usage

To run the project, execute the following command:

1. git clone https://github.com/teitonny/Todo-List-v2.git

2. cd Todo-List-v2

3. npm init -y

Run tests

To run tests, run the following command:

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

• npx eslint . --fix

Deployment

You can deploy this project using:

• github pages or any other option

(back to top)

👥 Authors

👤 Tonny Tei

• GitHub: @githubhandle
• Twitter: @twitterhandle
• LinkedIn: LinkedIn

(back to top)

🔭 Future Features

Describe 1 - 3 features you will add to the project.

• [use a database such as sql or mongo db]

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

Write a message to encourage readers to support your project

If you like this project...

(back to top)

🙏 Acknowledgments

• Thanks to Webpack for the documentation on webpack setup

• Also, I would like to thank Microverse team for this journey so far.

(back to top)

📝 License

This project is MIT licensed.

NOTE: we recommend using the MIT license - you can set it up quickly by using templates available on GitHub. You can also use any other license if you wish.

(back to top)