QuickWrench API

Backend API powering the QuickWrench web application ⚡

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 📦

• Python 3.12+

sudo apt install python3

• Docker (optional for containerized deployment)

sudo apt install docker.io

Installation ⚙️

1. Clone the repo

git clone https://github.com/quickwrench/quickwrench-api.git

2. Navigate to the project directory

cd quickwrench-api

3. Set up a virtual environment and activate it

python3 -m venv venv
source venv/bin/activate

4. Install dependencies

pip install -r reqs/dev.txt

5. Apply database migrations and load initial data

python src/manage.py migrate
python src/manage.py loaddata

(back to top)

Usage 🔧

Here is how to use the project:

1. Start the development server

python src/manage.py runserver

2. Visit http://127.0.0.1:8000 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)