Giter Club home page Giter Club logo

dev-mamun / js-todo-list Goto Github PK

View Code? Open in Web Editor NEW
8.0 2.0 0.0 563 KB

This is Microverse HTML/CSS & JavaScript project for student. Build this project using javascript. .it is a simple website that displays a list of To do tasks and allows you to add and remove tasks from that list

Home Page: https://dev-mamun.github.io/js-todo-list/dist/

License: MIT License

HTML 6.82% JavaScript 71.56% CSS 21.62%
javascript css webpack html nodejs

js-todo-list's Introduction

๐Ÿ“— Table of Contents

๐Ÿ“– To DO List

Organize your work and life, finally. Become focused, organized, and calm with Todolist. It simply lists the things that you need to do and allows you to mark them as complete.

๐Ÿ›  Tech Stack

  • HTML
  • CSS
  • JavaScript ES6
  • NodeJS
  • Webpack

Key Features

  • To Do List
  • Add New
  • Delete

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

  • GIT
    • if you don't have git installed on your machine you can download it from here.
  • Linter
    • You can get install guide from here
  • Node.js & Npm
    • if you don't have npm installed on your machine you can download it from here

Setup

Once you have git installed on your machine you can clone project by running the command below. To clone your project to your local machine

  git clone [email protected]:dev-mamun/js-todo-list.git

Alternatively, you can download the zip file of your project by clicking on the Code button on the right side of your project page and clicking on Download ZIP

Install

Install this project with:

  cd js-todo-list.git
  npm install

Usage

To run the project, use the following :

  npm run dev

(back to top)

Run tests

To run tests, run the following command:

To check for html errors run:

  npx hint .

To check for css errors run:

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

To check for js errors run:

  npx eslint .

๐Ÿ‘ฅ Author

๐Ÿ‘ค Abdullah AL mamun

๐Ÿ”ญ Future Features

  • N/A

๐Ÿค Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

โญ๏ธ Show your support

Give a โญ๏ธ if you like this project!

If you like this project feel comfortable to endorse the author. You can contact the author via Twitter or Linkedin or directly message at [email protected]

(back to top)

๐Ÿ™ Acknowledgments

I would like to thank...

  • Teammates
  • Mentors
  • YouTube tutorials
  • Microverse guides
  • Google Search

(back to top)

โ“ FAQ

-Why use linters?

  • The use of linters helps to diagnose and fix technical issues, also linters can help teams achieve a more readable and consistent style, through the enforcement of its rules.

-Why use modular programming?

  • Modular programming usually makes your code easier to read because it means separating it into functions that each only deal with one aspect of the overall functionality.

-Why use OOP?

  • With this type of programming, a program comprises objects that can interact with the user, other objects, or other programs. This makes programs more efficient and easier to understand.

(back to top)

๐Ÿ“ License

This project is MIT licensed.

(back to top)

js-todo-list's People

Contributors

dev-mamun avatar adarachel avatar

Stargazers

 avatar Moses Ezechukwu avatar Theophilus Doku avatar  avatar Lorenzo avatar Salma Ibrahim avatar Shafiu Ibn Yushawu avatar Olanrewaju Oduola avatar

Watchers

 avatar  avatar

js-todo-list's Issues

Todo List review

Todo List review

your code is organized and professional ๐Ÿ˜„
you have done a great job implementing testing in to Do list ๐Ÿ‘ But I would like to suggest you something to make your test increase accuracy ๐Ÿ†—

  1. I would like to suggest in testing adding data check exactly if your Index and description are added not a global check to be defined
    describe('Add function', () => {
    it('Store item in local storage', () => {
    todo.saveItems('jest test');
    expect(todo.getItems()).toBeDefined();
    });

please try to look at this code ๐Ÿ˜ƒ

  • please first make sure to clear local storage in testing
    image

then refer to these lines of code ๐Ÿ†—

image

please I would suggest you use ES6 structure, especially in function ๐Ÿ‘

It will be better to use an arrow in this Function as an ES6 structure in functions ๐Ÿ’ฏ

export default function Status($items, $id, $status) {
$items.find((item) => item.index === $id).completed = $status;
localStorage.setItem('items', JSON.stringify($items));
}

Happy coding time ๐Ÿ‘ ๐Ÿ‘ ๐Ÿ‘

Peer to peer review

  • The code doesn't have any linters error
  • using ES6 syntax
  • Not DRY
  • Using proper names

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.