Skip to content

quickwrench/quickwrench-frontend

Repository files navigation

Logo

QuickWrench React

Frontend for the QuickWrench web application 🎨

StandWithPalestine GitHub License GitHub Actions Workflow Status GitHub Tag GitHub issues

Getting Started · Report Bug · Request Feature

About The Project ✨

QuickWrench is an innovative platform designed to connect users with trusted car mechanics for scheduling maintenance and repair services. With QuickWrench, workshops can grow their customer base while users enjoy seamless appointment scheduling, tailored service suggestions, and reliable reviews.

(back to top)

Getting Started 🚀

Follow these steps to set up the project locally.

Prerequisites 📦

  • NodeJS
sudo apt install nodejs
  • NPM
sudo apt install npm
  • Docker (optional for containerized deployment)
sudo apt install docker.io

Installation ⚙️

  1. Clone the repo
git clone https://github.com/quickwrench/quickwrench-frontend.git
  1. Navigate to the project directory
cd quickwrench-frontend
  1. Install dependencies
npm install

(back to top)

Usage 🔧

Here is how to use the project:

  1. Start the development server
npm run dev
  1. Visit http://127.0.0.1:5173 in your browser.

(back to top)

Contributing 👥

Contributions are welcome! To get started:

  1. Fork the repository
  2. Create a branch for your feature (git checkout -b feat/amazing-feature)
  3. Commit your changes (git commit -m 'feat: add amazing-feature')
  4. Push the branch (git push origin feat/amazing-feature)
  5. Open a Pull Request

(back to top)

License 📜

Distributed under the GPL v3 License. See LICENSE.txt for more information.

(back to top)

About

QuickWrench web app frontend written using React 🎨

Topics

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors 3

  •  
  •  
  •