Giter VIP home page Giter VIP logo

microverse-todo-list's Introduction

Todo List

๐Ÿ“— Table of Contents

๐Ÿ“– Awesome books

Todo List is a Frontend Javascript project in the Microverse curriculum. It is about add/remove/edit your daily task and save them to the localstorage.

๐Ÿ›  Built With

Tech Stack

Client

Key Features

  • Add your daily task
  • Edit your daily task
  • Check/Uncheck your daily task
  • Remove your daily task
  • Save your data on localstorage

(back to top)

๐Ÿš€ Live Demo

(back to top)

๐Ÿ’ป Getting Started

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

Prerequisites

In order to run this project you'll need:

  • NodeJS
  • VSCode

Setup

Clone this repository to your desired folder:

  cd my-folder
  git clone https://github.com/M-AminAlizadeh/Microverse-todo-list.git

Install

Install this project with:

  cd my-project
  npm install

Usage

To run the project start live server. To use lints, run following commands:

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

Deployment

You can deploy this project by pushing to your own github page

(back to top)

๐Ÿ‘ฅ Authors

๐Ÿ‘ค Amin

(back to top)

๐Ÿ”ญ Future Features

  • Using Webpack module bundler
  • Using es6
  • Using Bootstrap

(back to top)

๐Ÿค Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

โญ๏ธ Show your support

If you like this project give it a โญ

(back to top)

๐Ÿ™ Acknowledgments

I would like to thank all the team members for their support during the development phase.

(back to top)

๐Ÿ“ License

This project is MIT licensed.

(back to top)

microverse-todo-list's People

Contributors

m-aminalizadeh avatar

Stargazers

 avatar

Watchers

 avatar

microverse-todo-list's Issues

Peer to peer code review

Wow, your project looks great ๐Ÿ‘Œ๐Ÿ‘Œ๐Ÿ‘Œ๐Ÿ‘Œ so far but there are a few issues we will like you to take note of.

  • When keep adding tasks overflow on the Y-axis of the page should be removed โœ”
  • After clearing all selected items, when we add new items the cleared item shows up with the new item. Please look into that. ๐Ÿฑโ€๐Ÿ๐Ÿฑโ€๐Ÿ๐Ÿฑโ€๐Ÿ

Cheers, and happy coding partner! ๐Ÿ‘๐Ÿ‘Š๐Ÿ‘Œ

Do I follow JavaScript best practices?

According to JavaScript Best Practices, DRY, KISS, YAGNI, and HTML & CSS:

Here are some issues related to JavaScript best practices:

  • The code has a mix of arrow functions and traditional functions. It is recommended to be consistent with the use of arrow functions throughout the code.
  • Redundant code: The saveTodoItems() function is called twice in the addTodo() function.
  • Unused imported module: The checkbox check module is imported but not used anywhere in the code
  • Code repetition: The toggleDeleteIcon function is defined twice in the code, once as an imported module and once within the same file.
  • Large functions: Some functions, such as displayTodoItems() and addTodo(), are quite large and could be refactored into smaller, more modular functions

Here are the issues related to HTML and CSS best practices:

  • Lack of semantic HTML: The code uses div and li elements without any semantic meaning, which can make the code harder to understand and maintain

Does my coding partner follow JS best practices?

According to JavaScript Best Practices, DRY, KISS, YAGNI, and HTML & CSS:

Here are some issues related to JavaScript best practices:

  • Use of document to access the DOM: The code uses document to access the DOM, which is not efficient and can slow down the application. A better approach would be to use a variable to store the element and then access it when needed.
  • Unclear variable names: Some of the variable names used in the code are unclear and don't follow best practices for naming conventions. For example, Add and Remove don't accurately describe what the functions do.
  • Inefficient code: The code could be made more efficient in certain areas. For example, the Display function is called multiple times, even when there is no need to update the display specifically in ClearAll. function.

The HTML code seems well-structured and follows best practices. However, here are a few suggestions:

  • Use semantic HTML tags to improve the readability and structure of the page. For example, use for the header, for the main content area,
    for the different sections, for navigation, for the footer,
  • Add alt text to the element for better accessibility.

Thanks.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.