To Do List

📗 Table of Contents

• 📖 About the Project
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 🚀 Live Demo
• 💻 Getting Started
  • Prerequisites
  • Setup
  • Run tests
  • Deployment
• 👥 Authors
• 🔭 Future Features
• 🤝 Contributing
• ⭐️ Show your support
• 🙏 Acknowledgements
• 📝 License
• 🖼️ Project Gallery

📖 To Do List

The To Do List is a web application that lists everything that a person has to do.

• The most important tasks are located at the top of the list.
• The least important tasks are located at the bottom of the list and uses a index of each task.

This project is represented under Module 2 "JavaScript and Networking".

To Do List is a...

🛠 Built With

Tech Stack

The To Do List project is built and configured using the following tools:

Languages

• HTML
• CSS
• JavaScript

Development Applications

• Visual Studio Code
• Bootstrap
• Webpack

Git / GitHub

• Git
• Github
• Github Pages

Web Configuration Applications

• Lighthouse
• Stylelint
• Webhint
• ES Lint

Key Features

The features of the To Do List includes:

• Adding a new task
• Removing a listed task
• Marking a selected item as "complete"
• Removing all listed items at once

(back to top)

🚀 Live Demo

The Live Demo of the project is live! Please click the link below. 👇

Live Demo Link

(back to top)

💻 Getting Started

Describe how a new developer could make use of your project.

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

Prerequisites

In order to run this project you need:

• To have Visual Studio Code (VSC) ready while loading the project.
• To have a preferable web browser ready while viewing the project. Microsoft Edge and Google Chrome (their latest version) are considerd the best web browsers for viewing.
• GitHub Desktop also be used as an option, but VSC is recommended code editor because of their git capability, as well as configuring the Web Linters (Lighthouse/Stylelint/Webhint/ES Lint).

Also, these basic requirements are needed in order to fully understand how the project fully works from the start:

• Should have a basic knowledge of HTML, CSS, and JS (JavaScript).
• Also, it is recommended to have a basic knowledge on how Git and GitHub works.

Setup

Before starting with the project, follow these instructions:

• Visual Studio Code Download Link
• How to Install Visual Studio Code on Windows 7/8.1/10/11
• GitHub Desktop Download Link
• Instructions on Using GitHub Desktop easily

Clone this repository to your desired folder:

• git clone git@github.com:katarighe/awesome-books.git

Install this project with Visual Studio Code:

• On the Visual Studio Code welcome page, select "Clone Git Repository" and click.
• Paste the copied repo into the textbox and click "Clone from GitHub" on the top.
• Choose which folder where you are going to save the cloned GitHub Repository into your local PC.
• Wait for the setup to be complete until it downloads all the content entirely from the GitHub server.

Run tests

To run the project through the web browser, follow these instructions:

• Press "Go Live" on the bottom of the visual Studio Code.
• The program will open on the browser of your choice, such as Microsoft Edge, Google Chrome, Mozilla Firefox, Opera or Brave.
• However, the project will load on Microsoft Edge by default. If you wish to view the project on a different browser, copy this (http://127.0.0.1:5500/) address on the Edge browser and past it to your web browser of your choice.
• If you want to view the project on smartphone mode, right click your mouse and select "Inspect". Once it is opened, you can view the website in mobile mode, the default size of a mobile version is set at 375x768 while desktop format is at 1024x768.

Deployment

You can deploy this project using GitHub Pages, it is free and easy to apply in your project without difficulties.

(back to top)

👥 Authors

👤 Mohamed Aden Ighe

• GitHub: @katarighe
• Twitter: @katarighe
• LinkedIn: @mighe

(back to top)

🔭 Future Features

The following featurs will be add to the project in the future.

• Add Button: The Add Button will be added into the application for better convience when interacting with the mouse.
• Categories: This feature will help us divide the To Do list into different categories such as Home, Work, and Travel.
• Better User Interface (UI): Improving the UI of the To Do List will help users visitng this app more friendly and accessible.

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

Give a star⭐️ or a thumbs up 👍 if you like this project! You can visit my GitHub profile for more of my projects.

(back to top)

🙏 Acknowledgments

• My coding partners for helping me guide the project development
• Project supervised by Microverse
• Creative Commons 4.0 License

(back to top)

📝 License

This project is MIT licensed.

NOTE: we recommend using the MIT license - you can set it up quickly by using templates available on GitHub. You can also use any other license if you wish.

(back to top)

🖼️ Project Gallery

(back to top)