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

https://github.com/tsheporamantso/to-do-list-code-review

In this project, I practice code reviewing, and ensuring that I use correct GitHub flow, HTML,CSS and JavaScript best practices
https://github.com/tsheporamantso/to-do-list-code-review

Last synced: 7 months ago
JSON representation

In this project, I practice code reviewing, and ensuring that I use correct GitHub flow, HTML,CSS and JavaScript best practices

Awesome Lists containing this project

README

          

Gladwin Tshepo Ramantso





To Do List



# 📗 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)
- [📝 License](#license)

# 📖 To Do List

This project is an online To Do list that display users activities planned to do, also allow user to add task planned to accomplish and delete those already done

**To Do List** In this project, I built a basic to-do list that allow user to add planned activities and delete those already accomplished, used Webpack to bundle al my files

## 🛠 Built With

- HTML
- CSS
- JavaScript(ES6)
- Webpack

### Tech Stack

Version Control

Visual Studio Code

Node js

### Key Features

- **JavaScript Webpack**
- **Basic UI with plain HTML**

(back to top)

## 🚀 Live Demo

- [Live Demo]( https://tsheporamantso.github.io/To-Do-List/)

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

- Visual Studio Code.
- Node JS.
- Git bash.
- GitHub Account.

Example command:

```sh
gem node js
```

### Setup

Clone this repository to your desired folder:

Use git clone command or download ZIP folder

Example commands:

```sh
cd my-folder
git clone git@github.com:tsheporamantso/To-Do-List.git
```

### Install

Install this project with:

npm

Example command:

```sh
cd my-project
npm init -y
```

### Usage

To run the project, execute the following command:

npm start or live server

Example command:

```sh
GitHub Pages Server
```

### Run tests

To run tests, run the following command:

npm test

Example command:

```sh
npx stylelint "**/*.{css,scss}"
```
```sh
npx eslint .
```
```sh
npm start
```
```sh
npm run dev
```

### Deployment

You can deploy this project using:

GitHub Pages

Example:

```sh
https://tsheporamantso.github.io/To-Do-List/
```

(back to top)

## 👥 Authors

👤 **Gladwin Tshepo Ramantso**

- GitHub: [@tsheporamantso](https://github.com/tsheporamantso)
- Twitter: [@ramgt001](https://twitter.com/ramgt001)
- LinkedIn: [Tshepo Gladwin Ramantso](https://www.linkedin.com/in/tshepo-ramantso-b6a35433/)

(back to top)

## 🔭 Future Features

- [ ] **Add and removing items**
- [ ] **Interactive list**

(back to top)

## 🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page](https://github.com/tsheporamantso/To-Do-List/issues).

(back to top)

## ⭐️ Show your support

If you like this project please follow us on github & twitter and also connect on Linkedin.

(back to top)

## 🙏 Acknowledgments

I would like to thank Microverse for this exercise and the contribution by my coding partner.

(back to top)

## 📝 License

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

(back to top)