https://github.com/sonickmumba/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. Built using ES6 and Webpack
https://github.com/sonickmumba/to-do-list

css es6 html javascript unit-testing webpack

Last synced: 9 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. Built using ES6 and Webpack

• Host: GitHub
• URL: https://github.com/sonickmumba/to-do-list
• Owner: Sonickmumba
• Created: 2022-08-17T18:08:35.000Z (about 2 years ago)
• Default Branch: master
• Last Pushed: 2023-05-19T21:44:40.000Z (over 1 year ago)
• Last Synced: 2024-10-10T09:42:14.683Z (27 days ago)
• Topics: css, es6, html, javascript, unit-testing, webpack
• Language: JavaScript
• Homepage:
• Size: 476 KB
• Stars: 4
• Watchers: 1
• Forks: 0
• Open Issues: 3
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

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

# To-do List

> In this project, I will build a simple HTML list of To Do tasks. "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. This web page will be built using webpack and served by a webpack dev server.

## Built With

- HTML and CSS

- Frameworks: N/A

- Technologies used: GIT, GITHUB, LINTERS

- npm

- Webpack

## Live Demo

Check **Live Demo** [here.](https://sonickmumba.github.io/To-do-list/dist/.)

## Getting Started

> To get a local copy up and running follow these simple example steps.

### Prerequisites

- npm (node package manager) – to be able to install packages locally.

- A github Account – to be able to use github actions.

### Setup

Use 'git clone https://[email protected]:Sonickmumba/To-do-list.git' to clone the repository to your local environment and begin working on it.

- run **'npm init'** to install dependancy packages.

- run **'npm run build'** to build the project and to generate dist files.

- run **'npm start'** to run you project in development mode.

### Usage

- Run npm start

### Run tests

- run Webhint linter

    - Run npx hint . on the root of your directory of your project.

- run Stylelint linter

    - Run npx stylelint "**/*.{css,scss}" on the root of your directory of your project.

- run ESLint linter

    - Run npx eslint . on the root of your directory of your project.

- run gulp

    - Run gulp  on the root of your directory of your project.

### Deployment

To run the project open the downloaded folder (after extraction) then run the "**index.html**" file in your browser.

## Authors

👤 **Author1**

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

- Twitter: [@Sonick](https://twitter.com/MumbaSonick)

- LinkedIn: [Sonick Mumba](https://www.linkedin.com/in/sonick-m-301557a2/)

## 🤝 Contributing

Contributions, issues, and feature requests are welcome!

## Acknowledgement

Matt Shwery [@mshwery](https://web.archive.org/web/20190228042842/https://twitter.com/mshwery) for the Design used.

## Show your support

Give a ⭐️ if you like this project!

## 📝 License

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