https://github.com/bushmusi/todo-list

A simple to-do list web application built with ES6 and bundled with webpack. Checkout the awesome features it offers.
https://github.com/bushmusi/todo-list

css eslint html javascript stylelint

Last synced: 7 days ago
JSON representation

A simple to-do list web application built with ES6 and bundled with webpack. Checkout the awesome features it offers.

• Host: GitHub
• URL: https://github.com/bushmusi/todo-list
• Owner: bushmusi
• License: mit
• Created: 2022-02-25T01:51:09.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2022-03-05T07:23:03.000Z (over 2 years ago)
• Last Synced: 2023-03-09T07:42:31.995Z (over 1 year ago)
• Topics: css, eslint, html, javascript, stylelint
• Language: JavaScript
• Homepage: https://bushmusi.github.io/todo-list/
• Size: 544 KB
• Stars: 5
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

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

# Todo List

This is a book shelve website dedicated to store collection of books, add new books and delete books. 

In this project, you will be using javascript arrays and object to store the list of books and saving the book colection in the local storage. Do not use any other framework, just pure javascript. After you are done with the project, run tests and deploy.

### [Live Demo Link](https://bushmusi.github.io/todo-list/)

![screenshot](./app_screenshot.png)

## Built With

- HTML5, Javascript

- CSS3

- Linters

## Getting Started

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

## Prerequisites

- Have a good knowledge on how to parse UI designs

- Have VSCode or other text editor installed. [Link to download VSCode](https://code.visualstudio.com/download)

- Install node package. [Link to download node](https://nodejs.org/en/download/)

- Have git installed.[Link to download git](https://git-scm.com/downloads)

- Create a github repository.

## Setup

- `git clone https://github.com/bushmusi/todo-list.git`

- `cd todo-list/`

- Install packages:  `npm install`

- Start Live Server: `npm start`

-Follow the HTML-CSS linter confuguration to docs to setup linters [Link to Microverse linter docs](https://github.com/bushmusi/linters-config/tree/master/html-css-js)

## Run tests

For tracking linters errors locally, you need to follow these steps:

- For tracking linter errors in HTML file run:

1. `npm install --save-dev [email protected]`

2. `npx hint .`

- For tracking linter errors in CSS file run:

1. `npm install --save-dev [email protected] [email protected] [email protected] [email protected]`

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

- For tracking linter errors in Javascript file run:

1. `npm install --save-dev [email protected] [email protected] [email protected] [email protected]`

2. `npx eslint .`

## Deployment

- Use GitHub pages to deploy website

- For more information about publishing sources, see [About github pages](https://pages.github.com/)

## Author

👤 **Bushra**

- GitHub: 

    - [Bushra](www.github.com/bushmusi)

## 🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page](../../issues/).

## Show your support

Give a ⭐️ if you like this project!

## Acknowledgments

- Microverse 

- Coding Partners

- Code Reviewers

## 📝 License

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