Skip to content
This repository has been archived by the owner on Oct 1, 2023. It is now read-only.
/ react-todo-app Public archive

"react-todo-app " is a tool that helps to organize a day

License

Notifications You must be signed in to change notification settings

lily4178993/react-todo-app

Repository files navigation

Table of Contents 📗



React Todos 📖

React Todos is a tool that helps to organize your day. It simply lists the things that you need to do and allows you to mark them as complete.


Built With 🛠

Tech Stack 🗜️

Client
  • HTML5 markup to build raw structure of this web page

  • CSS3 custom properties
  • React Js

  • Linters for coding convention and coding formating



Key Features 🏷️

  • Adding a new item
  • Removing a selected item
  • Marking a selected item as complete

(back to top)



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

  git clone https://github.com/lily4178993/react-todo-app.git
  • Navigate to the folder
cd react-todo-app
code .
  • Checkout the branch
git checkout dev



Install 🏗️

Install all dependencies:

    npm install



Usage 📂

To run the project, open your terminal and tap the following line.

    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 "**/*.{js,jsx}" --fix



(back to top)



👤 Author

Nelly Telli

(back to top)



Future Features 🔭

  • Add About and Contact Pages
  • Add editing functionalities to Todos list items

(back to top)



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 🌟

Thank you for taking the time to explore my GitHub project! Your support means a lot to me. If you find my project valuable and would like to contribute, here are a few ways you can support me:

  • Star the project ⭐️
  • Fork the project 🍴 🎣
  • Share with others 🗺️

(back to top)



Acknowledgments 🙏

I would like to express my sincere gratitude to Microverse, the dedicated reviewers, and my partner.

I would also like to thank Icons8 for all the images and icons I used in this project.

(back to top)



License 📝

This project is MIT licensed.

(back to top)