📗 Table of Contents

• 📗 Table of Contents
• 📖 [todo-react-app]
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 🚀 Live Demo
    • You can find the live version of this web application in this link =>todo-react-app
  • 💻 Getting Started
    • Prerequisites
    • Setup
    • Install
    • Usage
    • Run tests
    • Deployment
  • 👥 Authors
  • 🔭 Future Features
  • 🤝 Contributing
  • ⭐️ Show your support
  • 🙏 Acknowledgments
  • 📝 License

📖 todo-react-app

todo-react-app is an application that is built with react and bundled with Vite. It essentially provides a login page, which once authenticated, gives access to the edit button. The list of todos are display on the Home page. Other pages are also accessible with routers.

🛠 Built With

Tech Stack

Client

• HTML
• CSS
• JAVASCRIPT
• React

Key Features

• [Linter checks]
• [Vite]
• [JavaScript APIs]
• [CSS grid and flexbox]

(back to top)

🚀 Live Demo

todo-react-app

(back to top)

💻 Getting Started

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

(back to top)

Prerequisites

In order to run this project you need:

• The current version of node
• To have Git installed on your local machine
• Node Package manager (npm)
• An editor such as Visual Studio Code

(back to top)

Setup

Clone this repository to your desired folder:

• Create your classic access token from github.com
• run "git clone https://{access_token}@github.com/username/{repo_name}.git"
• Update your git identity by running "git config --global user.email "[email protected]""
• Update your name on git by running "git config --global user.name "your_name"

(back to top)

Install

Install this project by running npm install

(back to top)

### Usage

To run the project, execute the following command:

  use git bash to open in Vs code
  use `npm run dev` to run web dev server

(back to top)

Run tests

To run tests, run the following command:

Run `npx stylelint "**/*.{css,scss}" --fix` to fix linters
Run `npx eslint "**/*.{js,jsx}" --fix` to fix linters"

(back to top)

Deployment

You can deploy this project using:

• github pages

- npm run deploy

(back to top)

👥 Author

👤 Damilare Ismaila

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

(back to top)

🔭 Future Features

• [contact form page for customers]
• [A feature for alternative list of movies]
• [A feature for voting the best item on the list]

(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, kindly drop a star for me.

(back to top)

🙏 Acknowledgments

I would like to use this medium to appreciate Microverse for giving me this type of opportunity.

(back to top)

📝 License

This project is MIT licensed.

(back to top)