Skip to content

To Do List is a simple a simple web page that displays a list of To Do tasks. It is built using webpack and served by a webpack dev server.

Notifications You must be signed in to change notification settings

joyapisi/To-Do-List

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

52 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

To Do List

HTML, CSS and JavaScript To Do List Project

πŸ“— Table of Contents

πŸ“– [To_Do_List]

[To_Do_List] is a simple a simple web page that displays a list of To Do tasks inserted by a user. It is built using webpack and served by a webpack dev server.

πŸ›  Built With

Tech Stack

Javascript runtime environment JS Packages Version control

Key Features

  • [Webpack]
  • [Desktop-Version]
  • [Dynamic-Design]

(back to top)

πŸŽ₯ Video Explanation Coming soon!

πŸš€ Live Demo Live Demo

πŸ’» Getting Started

Creating your first "To DO List" project

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

Prerequisites

In order to run this project you need:

-A Git hub account -Git bash -Node JS -Webpack -Visual Studio Code as your code editor

Setup

Clone this repository to your desired folder:

  cd my-folder
  git clone[(https://github.com/joyapisi/To-Do-List.git)]

Understand Set Up Requirements

Since this code is using webpack, run npm start in your terminal to run it instead of using the live server.

Understand Set Up Requirements

Define webpack

webpackis a static module bundler for modern JavaScript applications. When webpack processes your application, it internally builds a dependency graph from one or more entry points and then combines every module your project needs into one or more bundles, which are static assets to serve your content from.

Define Linters

A linter is a tool to help you improve your code. You can learn more about Linters here: (source: (https://www.testim.io/blog/what-is-a-linter-heres-a-definition-and-quick-start-guide/)).

Advantages of Linting:

  1. Fewer errors in production- The use of linters helps to diagnose and fix technical issues such as code smells. As a result, fewer defects make their way to production.
  2. Achieving a more readable and consistent style, through the enforcement of its rules.
  3. Having more secure and performant code.
  4. Having an objective and measurable assessment of code quality.
  5. Having fewer discussions about code style and aesthetic choices during code reviews.

Install webpack and linters

Install webpack

  • Follow the instructions here to set up webpack.

Steps to Install webpack

  • In the link above, go through these topics in order:

Install Linters

Linters for various programming languages are available for use, e.g. Rubocop for Ruby or ESLint for JavaScript.

There are many ways you can integrate a linter in your workflow:

-text editor plugin -GitHub Actions -GitHub apps

Steps to Install Linters

Note: The npm package manager is going to create a node_modules directory to install all of your dependencies. You shouldn't commit that directory. To avoid that, you can create a .gitignore file and add node_modules to it:

.gitignore

node_modules/

ESLint

Run

npm install --save-dev eslint@7.x eslint-config-airbnb-base@14.x eslint-plugin-import@2.x babel-eslint@10.x

Web Hint

This is a customizable linting tool that helps you improve your site's accessibility, speed, cross-browser compatibility, and more by checking your code for best practices and common errors.

NOTE: If you are using Windows, make sure you initialize npm to create package.json file.

npm init -y
  1. Run
    npm install --save-dev hint@7.x
    
    how to use npm: (https://docs.npmjs.com/downloading-and-installing-node-js-and-npm).
  2. Copy .hintrc to the root directory of your project.
  3. Do not make any changes in config files - they represent style guidelines that you share with your team - which is a group of all Microverse students.
  4. Run
    npx hint .
    
    Copy contents of .eslintrc.json to the root directory of your project
  5. Fix validation errors.

A mighty, modern linter that helps you avoid errors and enforce conventions in your styles.

  1. Run

npm install --save-dev stylelint@13.x stylelint-scss@3.x stylelint-config-standard@21.x stylelint-csstree-validator@1.x not sure how to use npm? Read this.

  1. Copy .stylelintrc.json to the root directory of your project.

  2. Do not make any changes in config files - they represent style guidelines that you share with your team - which is a group of all Microverse students.

If you think that change is necessary - open a Pull Request in this repository and let your code reviewer know about it. 4. Run npx stylelint "*/.{css,scss}" on the root of your directory of your project.

  1. Fix linter errors.

  2. IMPORTANT NOTE: feel free to research auto-correct options for Stylelint if you get a flood of errors but keep in mind that correcting style errors manually will help you to make a habit of writing a clean code!

(back to top)

πŸ‘₯ Authors

πŸ‘€ Joy Phoebe

🀝 Contributing

πŸ”­ Future Features

[Feature-1]

  • Add more styling (aesthetics)

[Feature-2]

  • Add mobile version

(back to top)

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

⭐️ Show your support

If you like this project, kindly leave a comment below and share it with someone who enjoys coding! Coding is all about continuous learning and allowing yourself to be a beginner. Keep going!

πŸ™ Acknowledgments

I'm thankful to Microverse for providing a study platform which guided me through this project.

❓ FAQ

  • [Question_1] An easier and quicker way to understand webpack?

    • This YouTubevideo will help you understand webpack better and in details
  • [Question_2] Where can I download node JS for installation?

πŸ“ License

This project is MIT licensed.

(back to top)

About

To Do List is a simple a simple web page that displays a list of To Do tasks. It is built using webpack and served by a webpack dev server.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published