NoelLincoln / react-to-do-list

A todo list application made with react

React To Do List Application

📗 Table of Contents

• 📖 About the Project

  • 🛠 Built With
    • Tech Stack
    • Key Features

• 💻 Getting Started

  • Setup
  • Prerequisites
  • Install
  • Usage
  • Run tests
  • Deployment

• 👥 Authors

• 🔭 Future Features

• 🤝 Contributing

• ⭐️ Show your support

• 🙏 Acknowledgements

• ❓ FAQ (OPTIONAL)

• 📝 License

📖 To do list

To do list is an application built using React and Vite .

🛠 Built With

Tech Stack

Client

• CSS
• React

Tools

• Visual studio code

Key Features

• Minimalistic
• User-friendly

(back to top)

💻 Getting Started

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

Prerequisites

In order to set up and run the application you need:

• A code editor preferably Visual Studio Code
• A web browser preferably Google chrome.

Basic requirements are needed in order to fully understand how the project fully works :

• Basic knowledge of HTML, CSS, and React.
• How to work with Git and GitHub.

Setup

Clone this repository to your desired folder:

  cd my-folder
  git clone https://github.com/NoelLincoln/to-do-list-vite.git

Install

Install this project with:

  cd to-do-list-vite
  npm install

Usage

To run the project run :

  npm run dev

Runs the app in the development mode. Open http://localhost:3000 to view it in your browser.

The page will reload when you make changes. You may also see any lint errors in the console

Run tests

To run tests, run the following command:

  npm test

Launches the test runner in the interactive watch mode.
See the section about running tests for more information.

Deployment

This project can be deployed on several platforms. Github pages is used for deployment. For detailed steps visit deploy create-react-app.

(back to top)

👥 Authors

👤 Noel Bryant

• GitHub: @githubhandle
• Twitter: @twitterhandle
• LinkedIn: LinkedIn

🔭 Future Features

• Dark Mode

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

If you like this project feel free to contact me.

(back to top)

🙏 Acknowledgments

I would like to thank the entire Microverse community and family for the support and motivation.

(back to top)

License

📝 License

This project is MIT licensed.

(back to top)