To-Do App

📗 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
• ❓ FAQ (OPTIONAL)
• 📝 License

📖 To-Do-List

This SPA helps user to add and keep their todo works, edit the list or remove the work when it is done. Objectives of this project are to learn how to:

• Create mobile and desktop version.
• Deploy it.
• Follow GitHub flow.
• Open pull requests in GitHub.
• Write descriptive, easy to understand commit messages.
• Write short, detailed, easy to understand descriptions of pull requests.
• Write a descriptive and easy to understand README in business English for every project submitted.
• Demonstrate an ability to submit a project for code review.
• Using HTML,CSS and JAVASCRIPT.
• Create a enviroment for testing, use Webpack with Jest
• webpack, css-loader, style-loader, stylelint-scss included as dependencies

🛠 Built With

HTML.

CSS.

JavaScript.

Git.

GitHub.

Webpack

Jest.

Key Features

We have made use of a couple of features mainly:

• webpack is used to bundle JavaScript Modules
• css-loader, style-loader, stylelint-scss are added to include css styles for individual modules
• jest library added for tests
• GitHub Pages used for deployment
• LocalStorage used to keep the record for Todo-list app

(back to top)

🚀 Live Demo

• Live Demo Link

(back to top)

💻 Getting Started

Setup

• Clone this project

- $ git clone https://github.com/Ali-0111/To-Do-List.git
- $ cd To-Do-List

• Install npm packages

$ npm install

Usage

• Open on live server dist/index.html
• or use:

- $ npm run start

Prerequisites

In order to run this project you need:

• Browser
• Visual Studio
• Install dependencies

Run tests

To run tests, run the following command:

- $ npm run test

Deployment

This page is deployed on:

- GitHubPages(Free service for deployment)

(back to top)

👥 Authors

👤 Qurban Ali Safari

• GitHub: @safari
• Twitter: @safari
• LinkedIn: LinkedIn

👤 ClintonYounge

• GitHub: @ClintonYounge
• Twitter: @ClintonYounge
• LinkedIn: LinkedIn

👤 mdg0410

• GitHub: @mdg0410
• Twitter: @mdg0410
• LinkedIn: LinkedIn

🔭 Future Features

This are some of the features coming soon.

• [Draggable Version]

(back to top)

🤝 Contributing

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 give a ⭐️

(back to top)

🙏 Acknowledgments

• 🙏 Microverse for its arrangements and supports.

We especially thank from these Code reviwers for their honest help and constructive feedbacks during the project:

• 🙏 KayLemba
• 🙏 AbayomiOlaoye
• 🙏 VICTOR-CHUKWU

📝 License

This work is licensed by MIT .

(back to top)