https://github.com/jugosack/to_do_list_review

https://github.com/jugosack/to_do_list_review

Last synced: 27 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/jugosack/to_do_list_review
• Owner: jugosack
• License: mit
• Created: 2023-01-23T22:25:03.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2023-01-27T19:33:15.000Z (almost 2 years ago)
• Last Synced: 2023-03-03T07:52:23.751Z (over 1 year ago)
• Language: JavaScript
• Size: 260 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# To-Do-list

My Microverse todo-list

 project (Module two)


# 📗 Table of Contents

- [📖 \[🎯 todo-list ](#-todo-list)

  - [🛠 Built With ](#-built-with-)

    - [Tech Stack ](#tech-stack-)

  - [🚀 Live Demo ](#-live-demo-)

  - [👁 Presentation ](#-presentation-)

  - [Deploy my website with github pages":](#deploy-my-website-with-github-pages)

  - [- Loom video link:](#-loom-video-link)

  - [💻 Getting Started ](#-getting-started-)

    - [Prerequisites](#prerequisites)

    - [Install](#install)

  - [Requirements](#requirements)

    - [Run tests](#run-tests)

    - [Deployment](#deployment)

  - [👥 Authors ](#-authors-)

  - [🔭 Future Features ](#-future-features-)

  - [🤝 Contributing ](#-contributing-)

  - [👋 Show your support ](#show-your-support)

  - [🔭Acknowledgments ](#acknowledgments-)

  - [📝 License ](#license)

# 📖 To Do List 

**To Do List** is a web page where the user can see a list of todos, they can also add or remove any todo to the list.

## 🛠 Built With 

  Technology

  


    
HTML

    
CSS

    
Javascript

    
Webpack

    
Linters (Lighthouse, Webhint, Stylelint, Eslint)

    
Git/GitHub work-flow 

  


(back to top)


### Tech Stack 

  Client

  


    
JavaScript

  

  


    
Html

  

  


    
CSS

  


  Server

  


    
N/A

  


Database

  


    
LocalStorage

  


## 🚀 Live Demo 

- [Live Demo Link]()

(back to top)


## 👁 Presentation 

- [Loom presentation Link]()

## Deploy my website with github pages":

[link to todo-list:](https://jugosack.github.io/To-Do-list/dist)

## - Loom video link:

[Loom walking through for my-awesome-books: ]()

## 💻 Getting Started 

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

### Prerequisites

- IDE to edit and run the code (We use Visual Studio Code 🔥).

- Git to versionning your work.

### Install

- first install package.json and node_modules run: 

npm init -y

- npm install --save-dev hint

- npm install --save-dev [email protected] [email protected] [email protected] [email protected]

or latest version:

- npm install --save-dev stylelint stylelint-scss stylelint-config-standard stylelint-csstree-validator

- npm install --save-dev [email protected] [email protected] [email protected] [email protected]

or latest version:

- npm install --save-dev eslint  eslint-config-airbnb-base  eslint-plugin-import  babel-eslint

## Requirements

- Linters configuration.

Clone the repository to get start with project, then make sure to install dependencies in the linters file located in the [linter](https://github.com/Bateyjosue/linters-html-css/blob/main/.github/workflows/linters.yml) file

(back to top)


### Run tests

- to test and check the html file/s is error-free run: 

npx hint . 

- to fix errors run:

npx hint . -f

- to test and check the css file/s is error-free run: 

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

- to fix errors run:

npx stylelint "**/*.{css,scss}" --fix

- to test and check the js file/s is error-free run: 

npx eslint .

- to fix errors run:

npx eslint . --fix

### Deployment

Check for the tests when you generate a pull request and fix the errors if any.

For stylelint error run:sudo npx stylelint "\*_/_.{css,scss}" --fix and it will the fix style issues automatically.

## 👥 Authors 

👤 **Jugoslav Achkoski**

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

- Twitter: [Jugoslav Achkoski](https://twitter.com/Jugosla22401325)

- LinkedIn: [Jugoslav Achkoski](https://www.linkedin.com/in/jugoslav-achkoski-3a074021/?originalSubdomain=mk)

## 🔭 Future Features 

- [ ] Add local storage to save todos

- [ ] Add functionality to add and remove todos

  

## 🤝 Contributing 

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page

## 👋 Show your support 

Give a ⭐️ if you like this project!

(back to top)


## 🙏 Acknowledgments 

- [Microverse Team](https://www.microverse.org/).

I would like to thank Microverse for the information provided to build this project.

(back to top)


## ❓ FAQ (OPTIONAL) 

- **Can I use the project for any purpose?**

  - Yes, you can use this files for anything you need.

- **Is the information saved in any database?**

  - No, all data is saved in Local Storage.

## 📝 License 

This project is [MIT](https://github.com/jugosack/To-Do-list/blob/main/LICENSE) licensed.

(back to top)