Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/c00p75/to-do-list

To-do list is website that saves changes in the browser's local storage and uses ES6 and Webpack to add a new item, remove a selected item, mark a selected item as complete, remove all items marked as complete at once, and reorder a selected items (as drag-and-drop) from the list. The functionality of the app is done using jest.
https://github.com/c00p75/to-do-list

css html javascript jest-tests webpack

Last synced: 2 days ago
JSON representation

To-do list is website that saves changes in the browser's local storage and uses ES6 and Webpack to add a new item, remove a selected item, mark a selected item as complete, remove all items marked as complete at once, and reorder a selected items (as drag-and-drop) from the list. The functionality of the app is done using jest.

Awesome Lists containing this project

README

        


logo

# 📗 Table of Contents

- [📖 About the Project](#about-project)
- [🛠 Built With](#built-with)
- [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)
- [⭐️ Show your support](#support)
- [❓ FAQ](#faq)
- [📝 License](#license)

# 📖 To-Do List

> A simple website that uses Javascript ES6 and Webpack to build a "To-do list" create, read, update, and delete (CRUD) application.

## 🛠 Built With

### Key Features

> Describe between 1-3 key features of the application.
- **Adding and removing list items.**
- **Marking a selected item as complete.**
- **Reordering a selected item (as drag-and-drop).**

(back to top)

## 🚀 Live Demo

- [Live Demo Link](https://c00p75.github.io/To-Do-List/dist/index.html)

(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:
- Node.js
- Browser (any)
- Working PC

### Setup

In order to Clone this repository to your PC please follow the below steps:
> Copy this link [https://github.com/c00p75/To-Do-List.git].
> Open your (cmd) or (git bash) and select your preffered directory, i.e. `cd desktop` to select the desktop as your working directory.
> Type the commad `git clone ` and the repo will be saved to your current working directory.

### Usage

To run the project, execute the following command:

> In your (cmd) or (git bash), set the current working directory to the downloaded folder. Next, run the command 'npm i' followed by `npm start` and the page will open in the browser.

### Run tests

In your (cmd) or (git bash), with the downloaded folder set as the current working directory, run the command `npm test`.

### Deployment

You can deploy this project using:
- Github page
- Hosting in a web server

(back to top)

## 👥 Authors George M'sapenda

> Mention all of the collaborators of this project.
👤 **Author1**
- GitHub: [@c00p75](https://github.com/c00p75)

(back to top)

## 🔭 Future Features

> Describe 1 - 3 features you will add to the project.
- **Adding Notifications for pending tasks.**
- **Connecting Project to Database.**

(back to top)

## ⭐️ Show your support

Give a ⭐️ if you like this project!

(back to top)

## ❓ FAQ

> Add at least 2 questions new developers would ask when they decide to use your project.
- **[How to install the node module in my project?]**

- [type in your cmd or gitbash (npm install)]

- **[How to clone this project to my local PC?]**

- [In the cmd or gitbash type (git clone )]

(back to top)

## 📝 License MIT

This project is [MIT](./LICENSE) 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)