/todo-react

To Do application built with react

Primary LanguageJavaScript

logo

Todo

Table of Contents 📋

Todo-List📖

Todo Is a simple react application that enables the user to add,edit,remove and delete tasks from the todo list.The application saves all the data to local storage and is built with Es6 syntax modularity rules and utilizes webpack.

Built With 🛠

Tech Stack 🗜️

Client
Javascript runtime environment
  • Node JS as a javascript runtime machine [git], a free and open source distributed version control system
Deployment


Key Features 🏷️

  • List Structure
  • Add items
  • Remove items
  • Edit todo item
  • Cross out completed todo items

(back to top)


Live Demo 🚀

This project is hosted on GitHub pages. The Live application can be found here.

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


Setup ⚙️

Clone this repository to your desired folder:

  cd my-folder
  git clone https://github.com/RileyManda/todo-react.git
  • Navigate to the folder
cd todo-list
  • Checkout the branch
git checkout main


Install 🏗️

Install all dependencies: All the dependencies are available in package.json and can be installed locally by running:

    npm install


Usage 📂

To run the project, in your terminal, execute the following commands:

    npm run build   npm start


Run tests 🧪

How should it be tested? To run tests, run the following command:

  • CSS linter errors run:
npx stylelint "**/*.{css,scss}" --fix
  • JavaScript linter errors run:
npx eslint . --fix


Deployment

This project was deployed using GitHub Pages. For more information about how to use GitHub pages read here 🤩. If you want to watch a video about how to use GitHub pages instead of reading click here ☺️.

(back to top)


👥 Authors

👤 Riley Manda

(back to top)


Future Features 🔭

  • [ ]There are no planned future features.

(back to top)


👥 Attribution

Contributing 🤝

If you have suggestions 📝, ideas 🤔, or bug reports 🐛, please feel free to open an issue on GitHub. Remember, every contribution, no matter how big or small, makes a difference.

(back to top)


Show your support 🌟

  • Star the project ⭐️: Show your appreciation by starring this GitHub repository. It helps increase visibility and lets others know that the project is well-received.

  • Fork the project 🍴 🎣: If you're interested in making improvements or adding new features, feel free to fork the project. You can work on your own version and even submit pull requests to suggest changes.

  • Share with others 🗺️: Spread the word about this project. Share it on social media, mention it in relevant forums or communities, or recommend it to colleagues and friends who might find it useful.

(back to top)


Acknowledgments 🙏

I would like to express my sincere gratitude to Microverse, the dedicated reviewers, and collaborators. Your unwavering support, feedback, and collaborative efforts have played an immense role in making this journey a resounding success. I am truly grateful for your contributions and for being an integral part of my achievements. Thank you for your continued support.

(back to top)


FAQ ❓

  • Question_1 Do I have to use the vs code specifically?
    • Answer_1 You can use any code editor of your choice.
  • Question_2 Where can I download node JS for installation?

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