An open API service indexing awesome lists of open source software.

https://github.com/chandan-devs-tech/to-do-list

📑"To-do list" is a tool that helps to organize a day. It simply lists the things that we need to do and allows us to mark them as complete. I will build a simple website that allows for doing that, and I will do it using ES6 and Webpack!
https://github.com/chandan-devs-tech/to-do-list

Last synced: 2 months ago
JSON representation

📑"To-do list" is a tool that helps to organize a day. It simply lists the things that we need to do and allows us to mark them as complete. I will build a simple website that allows for doing that, and I will do it using ES6 and Webpack!

Awesome Lists containing this project

README

          

To-do list

# 📗 Table of Contents

- [📗 Table of Contents](#-table-of-contents)
- [📖 \[To-do list\] ](#-to-do-list-)
- [🛠 Built With ](#-built-with-)
- [Tech Stack ](#tech-stack-)
- [Key Features ](#key-features-)
- [🚀 Live Demo ](#-live-demo-)
- [💻 Getting Started ](#-getting-started-)
- [Prerequisites](#prerequisites)
- [Setup](#setup)
- [Install](#install)
- [Run tests](#run-tests)
- [Deployment](#deployment)
- [👥 Authors ](#-authors-)
- [🔭 Future Features ](#-future-features-)
- [🤝 Contributing ](#-contributing-)
- [⭐️ Show your support ](#️-show-your-support-)
- [🙏 Acknowledgments ](#-acknowledgments-)
- [📝 License ](#-license-)

# 📖 [To-do list]

**[To-do list]** is 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. You will build a simple website that allows for doing that, and you will do it using ES6 and Webpack!

## 🛠 Built With

- HTML
- CSS
- JavaScript
- Linters
- Webpack
- Testing To Do list

### Tech Stack

- This project is created using JavaScript Classes, DOM and Use ES6 modules to write modular JavaScript.

- In this project I have write unit tests for the To Do list application. The testing project has been divided into two parts. In part 1 you will test functions responsible for adding and deleting list items. In part 2 you will test the status and content updates as well as the order re-position of items in the list.

### 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](https://chandan-devs-tech.github.io/To-Do-list/dist/)

(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:

- Laptop
- GitHub
- Git
- Internet connection.

### Setup

Clone this repository to your desired folder:

- cd Desktop
- git clone https://github.com/Chandan-devs-tech/To-Do-list.git

### Install

Install this project with:

- cd To-Do-list
- npm install

### Run tests

**[To run tests, run the following command:]**
- npx hint .
- npx stylelint "**/*.{css,scss}"
- npx eslint .

**[To Install & Run Jest]**
- npm i --save-dev jest

**[To Use Babel]**
- npm install --save-dev @babel/core @babel/cli
- npm install --save-dev @babel/core @babel/preset-env @babel/plugin-transform-modules-commonjs
- npx babel src --out-dir dist

**[Declare a .babelrc with configuration file]**

`{
"presets": ["@babel/preset-env"],
"plugins": ["@babel/plugin-transform-modules-commonjs"]
}`

**[To Excecute the test that Involves DOM Manipulation]**

- npm install --save-dev jsdom
- create jest.config.js file
- npm install --save-dev jest-environment-jsdom
- npm run test
-
### Deployment

I have deployed this project using: Github pages

(back to top)

## 👥 Authors

👤 **CHANDAN GUPTA**

- GitHub: [@githubhandle](https://github.com/Chandan-devs-tech)
- Twitter: [@twitterhandle](https://twitter.com/ChandanGuptaDev)
- LinkedIn: [LinkedIn](https://www.linkedin.com/in/chandangupta-devs/)

👤 **YUSUF SHOLOTAN**

- GitHub: [@githubhandle](https://github.com/yin-ka)
- LinkedIn: [LinkedIn](https://www.linkedin.com/in/yusuf-sholotan/)

(back to top)

## 🔭 Future Features

- [ ] **[Testing To Do list: part 2]**

(back to top)

## 🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page](https://github.com/Chandan-devs-tech/To-Do-list/issues)

(back to top)

## ⭐️ Show your support

If you like this project give me a ⭐️

(back to top)

## 🙏 Acknowledgments

I would like to thank [Microverse](https://www.microverse.org/go)

(back to top)

## 📝 License

This project is [MIT](https://github.com/Chandan-devs-tech/To-Do-list/blob/feature/listStructure/MIT.md) licensed.

(back to top)