Awesome To-Do List

📗 Table of Contents

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

📖 Awesome To-Do List

Awesome To-Do List is a basic To-Do List project built using webpack, JavaScript, HTML, and CSS. It allows users to create, manage, and track their daily tasks or to-do items. This README file provides an overview of the project and explains how to set it up and run it on your local machine.

🛠 Built With

Tech Stack

Client

• JavaScript

Server

• Local Storage

Database

• JavaScript

Key Features

• Create a new task
• Mark a task as completed

(back to top)

🚀 Live Demo

Click here to see the project's deployment on GitHub pages!

(back to top)

💻 Getting Started

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

Prerequisites

Before you proceed, ensure that you have the following installed on your machine:

• Node.js (v12 or above)
• npm (Node Package Manager)

Setup

Clone this repository to your desired folder:

  git clone git@github.com:sergio-usma/To-Do-List.git

Install

Install the project dependencies with:

  npm install

Usage

To run the project, execute the following command:

  npm run build

Run tests

To run tests, run the following command:

  npm run start

• Open your web browser and visit http://localhost:8080.
• You should now see the To-Do List application running in your browser.

Deployment

You can deploy this project using:

  npm run deploy

(back to top)

👥 Authors

👤 Author

• GitHub: @sergio-usma
• Twitter: @VonUsma
• LinkedIn: Sergio Andres Usma

(back to top)

🔭 Future Features

• Delete a task
• Filter tasks based on their status (All, Active, Completed)
• Clear all completed tasks

(back to top)

🤝 Contributing

Contributions are welcome! If you find any bugs or want to enhance the project with new features, please follow these steps:

1. Fork the repository.
2. Create a new branch for your feature or bug fix.
3. Make the necessary changes and commit them.
4. Push your changes to your forked repository.
5. Submit a pull request describing your changes.

Feel free to check the issues page.

(back to top)

⭐️ Show your support

If you like this project, please consider supporting us! Your support helps us to continue developing and improving our project for everyone to enjoy. Whether it's a small donation, sharing the project with your friends, or contributing your skills and expertise, every little bit makes a huge difference. With your support, we can create something truly amazing together. Thank you for being a part of our community and helping us to make a difference!

(back to top)

🙏 Acknowledgments

I would like to express my heartfelt gratitude to Microverse for the invaluable learning experience they have provided. The supportive community, dedicated mentors, and remote collaboration opportunities have enhanced my technical skills and prepared me for real-world projects. I extend my appreciation to the mentors and staff members for their guidance and support. The friendships and knowledge sharing within the Microverse community have made this journey truly rewarding.

(back to top)

❓ FAQ

• How do I set up the project?

  • Clone the repository from GitHub, and see the Setup section above for details.

• How can I contribute to the project?

  1. Fork the repository on GitHub.
  2. Create a new branch for your changes using git checkout -b my-feature-branch.
  3. Make your changes and commit them with descriptive commit messages.
  4. Push your changes to your forked repository.
  5. Submit a pull request to the original repository.
  6. Wait for feedback and iterate on your changes as needed.

(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)