ToDoList-App

KO | EN

gitlite — search

#python #java #python3 #arduino #golang #machine-learning #rust #html #flask #javascript #seismology #nodejs

★ 30 Open GitHub ↗

A website which permits users to manage their todo list by creating, removing, updating and deleting a new task. You can mark a task as complete.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

<div align="center">
 
 
 <h3>Microverse README</h3>
</div>

# 📗 Table of Contents

- [📗 Table of Contents](#-table-of-contents)
- [📖 To Do List App ](#-to-do-list-app-)
  - [🛠 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-)
  - [Author](#author)
  - [🔭 Future Features ](#-future-features-)
  - [🤝 Contributing ](#-contributing-)
  - [⭐️ Show your support ](#️-show-your-support-)
  - [🙏 Acknowledgments ](#-acknowledgments-)
  - [❓ FAQ ](#-faq-)
  - [📝 License ](#-license-)

# 📖 To Do List App <a name="about-project"></a>

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://user-images.githubusercontent.com/87370519/215631232-2c2b9128-b37c-4566-a918-9526941692ca.png)

## 🛠 Built With <a name="built-with"></a>

### Tech Stack <a name="tech-stack"></a>

<!--
<details>
 <summary>Client</summary>
 <ul>
 <li><a href="https://expressjs.com/">Express.js</a></li>
 </ul>
</details>
<details>
 <summary>Server</summary>
 <ul>
 <li><a href="https://expressjs.com/">Express.js</a></li>
 </ul>
</details>

<details>
<summary>Database</summary>
 <ul>
 <li><a href="https://www.postgresql.org/">PostgreSQL</a></li>
 </ul>
</details>
-->

### Key Features <a name="key-features"></a>

- **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)**

(<a href="#readme-top">back to top</a>)

## 🚀 Live Demo <a name="live-demo"></a>

- [Live Demo Link](https://miltonhenschel.github.io/ToDoList-App/)

(<a href="#readme-top">back to top</a>)

## 💻 Getting Started <a name="getting-started"></a>

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 stylelint@13.x stylelint-scss@3.x stylelint-config-standard@21.x stylelint-csstree-validator@1.x
```

```
npm install --save-dev eslint@7.x eslint-config-airbnb-base@14.x eslint-plugin-import@2.x babel-eslint@10.x
```

### 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 <a name="run-tests"></a>

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

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

```
npx eslint .
```

### Deployment <a name="deployment"></a>

To deploy this project run

```
npm run deploy
```

(<a href="#readme-top">back to top</a>)

## Author

👥 Henschel Nketchogue M. <a name="authors"></a>

- GitHub: [miltonHenschel](https://github.com/miltonHenschel)
- LinkedIn: [henschelnketchoguem](https://www.linkedin.com/in/henschelnketchoguem/)
- Twitter: [nketchogue](https://twitter.com/nketchogue)
- Instagram: [mpatchiehenschel](https://www.instagram.com/mpatchiehenschel/)

(<a href="#readme-top">back to top</a>)

## 🔭 Future Features <a name="future-features"></a>

- [ ] **Improve design**

(<a href="#readme-top">back to top</a>)

## 🤝 Contributing <a name="contributing"></a>

Contributions, issues, and feature requests are welcome! Feel free to check the [issues page](../../issues/).

(<a href="#readme-top">back to top</a>)

## ⭐️ Show your support <a name="support"></a>

Give a ⭐️ if you like this project!

(<a href="#readme-top">back to top</a>)

## 🙏 Acknowledgments <a name="acknowledgements"></a>

- [ ] **![](https://img.shields.io/badge/Microverse-blueviolet)**

(<a href="#readme-top">back to top</a>)

## ❓ FAQ <a name="faq"></a>

- **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
  ```

(<a href="#readme-top">back to top</a>)

## 📝 License <a name="license"></a>

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

(<a href="#readme-top">back to top</a>)

ToDoList-App

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README