FIXR - OBD2 Error Code Diagnosis and Parts Scanner

Fixr is a web application designed to assist users in diagnosing OBD2 error codes wirelessly from their vehicles and providing potential causes along with links to purchase the required car parts to fix the issue.

Table of Contents

• Introduction
• Demo
• Features
• Getting Started
  • Prerequisites
  • Installation
• Usage
• Technologies Used
• Contributing
• Authors
• License
• Acknowledgments

Introduction

FIXR simplifies the process of diagnosing OBD2 error codes by providing users with detailed information about the main cause and two additional possible causes for the error code. Additionally, it offers links to purchase the necessary car parts to address the primary issue.

Demo

Check out our live demo here.

Features

• Input OBD2 error code and submit for diagnosis.
• Display the main cause of the error code.
• Suggest potential fixes.
• Provide links to buy the required car parts for the main cause.
• Connect wirelessly via Bluetooth

Getting Started

Follow these instructions to get a copy of the project up and running on your local machine.

• Clone this repository
• Install ReactJS and Boostrap 5.3.2v if your IDE isn't including one
• Create a branch name 'New Feature' before committing
• Send us a message of your idea!

Prerequisites

List any prerequisites or dependencies that need to be installed before using the application.

• Note: Please ensure you have installed nodejs

Installation

Provide step-by-step instructions on how to install and set up the application locally.

• Check out ReactJS and Boostrap 5.3.2v documentations from official websites.

Usage

1. Open the FIXR website.
2. If you have the OBD2 error code, enter it you want to diagnose.
3. If you don't have the OBD2 error code, plug in the device, click the "SCAN NOW" button.
4. View the main cause and alternative causes of the error code.
5. Click on the links to purchase the necessary car parts.

Technologies Used

• Frontend Framework: ReactJS, Boostraps, HTML, CSS, JavaScript, Git, GitHub,
• Backend Framework: Djanglo, Python, Google Cloud
• Database: Google Cloud SQL
• UI/UX Design: Figma, Canva, Adobe Photoshop, Adobe Illustrator

Contributing

We welcome contributions from the community. To contribute to FIXR, follow these steps:

1. Fork the repository.
2. Create a new branch for your feature or bugfix.
3. Make your changes and commit them.
4. Open project folder in Visual Studio Code
5. In the terminal, run npm install
6. Run npm start to view project in browser
7. Push your changes to your fork.
8. Submit a pull request to the main repository.

Authors

• Tien Le
  • Front-End Engineer: Tien
• Sandro Dinklang
  • Back-End Engineer: Sandro
• Noe Sanchez
  • UI/UX Designer: Noe
• Alan Santoyo
  • Data Scientist: Alan

License

This project is licensed under the MIT - see the LICENSE file for details.

Acknowledgments

We would like to thank the following:

• Hackathon organizers for the opportunity.
• OBD2 device manufacturers for providing valuable data.
• The open-source community for their contributions to relevant libraries and frameworks.