Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/mailsg/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.
https://github.com/mailsg/to-do-list

Last synced: 7 days ago
JSON representation

"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.

Awesome Lists containing this project

README

        

# 📗 Table of Contents

- [📖 About the Project](#about-project)
- [🛠 Built With](#built-with)
- [Tech Stack](#tech-stack)
- [Key Features](#key-features)
- [🚀 Live Demo](#live-demo)
- [💻 Getting Started](#getting-started)
- [Setup](#setup)
- [Prerequisites](#prerequisites)
- [Install](#install)
- [Usage](#usage)
- [Run tests](#run-tests)
- [Deployment](#triangular_flag_on_post-deployment)
- [👥 Authors](#authors)
- [🔭 Future Features](#future-features)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [❓ FAQ (OPTIONAL)](#faq)
- [📝 License](#license)

# 📖 To Do List

**To Do List** is a web app that demonstrates a To Do List App.

## 🛠 Built With

### Tech Stack

HTML/CSS/JavaScript

GitHub

### Key Features

- **List Structure**
- **Add/Remove Tasks**
- **Interactive Tasks**
- **Webpack**

(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 browser
- git
- nodejs

### Setup

Clone this repository to your desired folder:

```sh
cd my-folder
git clone [email protected]:mailsg/To-do-list.git
```

### Install

Install this project with:

```sh
cd my-project
npm install
```

### Usage

To run the project, execute the following command:

```sh
Open index.html in browser
or
Open with Live server in Vscode
```

### Run tests

To run tests, run the following command:

```sh
npx stylelint "**/*.{css,scss}"
npx hint .
npx eslint .
```

(back to top)

## 👥 Author

👤 **Sandeep**

- GitHub: [@mailsg](https://github.com/mailsg)

(back to top)

## 🔭 Future Features

- [ ] **Profile Section**
- [ ] **News Section**
- [ ] **Join Section**

(back to top)

## 🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the [https://github.com/mailsg/To-do-list/issues](../../issues/).

(back to top)

## ⭐️ Show your support

If you like this project give me a follow and/or a star

(back to top)

## 🙏 Acknowledgments

I would like to thank Microverse for giving this opportunity to me to showcase my dev skills.

(back to top)

## 📝 License

This project is [MIT](./LICENSE) licensed.

(back to top)