https://github.com/quickwrench/quickwrench-api
QuickWrench backend API written using Django ⚡
https://github.com/quickwrench/quickwrench-api
backend django django-rest-framework openapi python python3 python312 quickwrench
Last synced: 11 months ago
JSON representation
QuickWrench backend API written using Django ⚡
- Host: GitHub
- URL: https://github.com/quickwrench/quickwrench-api
- Owner: quickwrench
- License: gpl-3.0
- Created: 2024-10-19T11:18:39.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-12-24T06:22:36.000Z (about 1 year ago)
- Last Synced: 2025-01-24T21:27:24.170Z (about 1 year ago)
- Topics: backend, django, django-rest-framework, openapi, python, python3, python312, quickwrench
- Language: Python
- Homepage:
- Size: 666 KB
- Stars: 0
- Watchers: 0
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
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.
## Getting Started 🚀
Follow these steps to set up the project locally.
### Prerequisites 📦
- Python 3.12+
```sh
sudo apt install python3
```
- Docker (optional for containerized deployment)
```sh
sudo apt install docker.io
```
### Installation ⚙️
1. Clone the repo
```sh
git clone https://github.com/quickwrench/quickwrench-api.git
```
2. Navigate to the project directory
```sh
cd quickwrench-api
```
3. Set up a virtual environment and activate it
```sh
python3 -m venv venv
source venv/bin/activate
```
4. Install dependencies
```sh
pip install -r reqs/dev.txt
```
5. Apply database migrations and load initial data
```sh
python src/manage.py migrate
python src/manage.py loaddata
```
## Usage 🔧
Here is how to use the project:
1. Start the development server
```sh
python src/manage.py runserver
```
2. Visit `http://127.0.0.1:8000` in your browser.
## 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
## License 📜
Distributed under the GPL v3 License. See `LICENSE.txt` for more information.