harshk04 commited on
Commit
d2212e9
·
verified ·
1 Parent(s): 8b90525

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +25 -113
README.md CHANGED
@@ -1,113 +1,25 @@
1
- # Automobile-Damage-Detection
2
-
3
- Welcome to the Automobile Damage Detection App! This application allows users to detect damages in cars and estimate repair costs using image processing and machine learning. The app also includes an admin portal for managing car data and monitoring application performance.
4
-
5
- ## 📌 Sneak Peek of Main Page 🙈 :
6
-
7
-
8
- https://github.com/user-attachments/assets/512308eb-e351-48f9-8a85-66a636a9c5ed
9
-
10
-
11
-
12
-
13
- ## Table of Contents
14
-
15
- - [Features](#features)
16
- - [Installation](#installation)
17
- - [Usage](#usage)
18
- - [File Structure](#file-structure)
19
- - [Contributing](#contributing)
20
- - [License](#license)
21
-
22
- ## Features
23
-
24
- ### User Portal
25
- - **Car Damage Detection**: Users can verify car authenticity by checking car details in the database. If the car data matches, users can upload an image of the damaged car, detect damaged parts, and get an estimated cost of damage.
26
- - **PDF Download**: Users can download a PDF report containing the predicted image, car details, damaged parts details, and the total estimated cost.
27
- - **Contact Us**: Users can fill out a form to get in touch with the developer or project owner.
28
-
29
- ### Admin Portal
30
- - **Home**: Admins can view an overview of the portal's features and some quick statistics about the current database.
31
- - **Get Car Data**: Admins can fetch and display all car data available in the database.
32
- - **Add New Car Data**: Admins can add new car information to the database.
33
-
34
- ## Installation
35
-
36
- 1. Clone the repository:
37
-
38
- ```sh
39
- git clone https://github.com/harshk04/Automobile-Damage-Detection
40
- cd automobile-damage-detection
41
- ```
42
-
43
- 2. Create and activate a virtual environment:
44
-
45
- ```sh
46
- python -m venv env
47
- source env/bin/activate # On Windows use `env\Scripts\activate`
48
- ```
49
-
50
- 3. Install the required packages:
51
-
52
- ```sh
53
- pip install -r requirements.txt
54
- ```
55
-
56
- 4. Run the application:
57
-
58
- ```sh
59
- streamlit run app.py
60
- ```
61
-
62
- ## Usage
63
-
64
- ### User Portal
65
- - Navigate to the **Home** page to get an overview of the app and its features.
66
- - Go to the **Car Damage Detection** page to start the damage detection process. Verify the car details and upload an image of the damaged car.
67
- - Visit the **Contact Us** page to reach out to the developer or project owner.
68
-
69
- ### Admin Portal
70
- - Access the **Admin Home** to view an overview and statistics about the database.
71
- - Use the **Get Car Data** page to fetch and display all car data in the database.
72
- - Go to the **Add New Car Data** page to input and save new car details.
73
-
74
- ## Admin Login Details
75
-
76
- To access the admin portal, use the following login credentials:
77
-
78
- - **Username**: `admin`
79
- - **Password**: `password`
80
-
81
- ## File Structure
82
-
83
- - `app.py`: Main application file for the user portal.
84
- - `car_damage_detection.py`: Contains the car damage detection logic.
85
- - `pdf_generator.py`: Generates a PDF report for the detected damages and estimated costs.
86
- - `utils.py`: Utility functions for fetching and adding car data.
87
- - `admin_portal.py`: Contains the admin portal functionalities.
88
-
89
- ## Contributing
90
-
91
- We welcome contributions! If you would like to contribute, please follow these steps:
92
-
93
- 1. Fork the repository.
94
- 2. Create a new branch (`git checkout -b feature-branch`).
95
- 3. Make your changes.
96
- 4. Commit your changes (`git commit -m 'Add some feature'`).
97
- 5. Push to the branch (`git push origin feature-branch`).
98
- 6. Open a pull request.
99
-
100
- ## License
101
-
102
- This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
103
-
104
-
105
- ### 📬 Contact
106
-
107
-
108
- If you want to contact me, you can reach me through below handles.
109
-
110
- &nbsp;&nbsp;<a href="https://www.linkedin.com/in/harsh-kumawat-069bb324b/"><img src="https://www.felberpr.com/wp-content/uploads/linkedin-logo.png" width="30"></img></a>
111
-
112
- © 2024 Harsh
113
-
 
1
+ ---
2
+ license: mit
3
+ title: 'Car detection '
4
+ sdk: streamlit
5
+ emoji: 🚀
6
+ colorFrom: yellow
7
+ colorTo: yellow
8
+ ---
9
+
10
+ # Space Overview
11
+
12
+ This is a simple Hugging Face Space. Make sure to check out the configuration reference at [Hugging Face Config Reference](https://huggingface.co/docs/hub/spaces-config-reference).
13
+
14
+ ## Setup Instructions
15
+ Please ensure that the following fields are configured correctly:
16
+ - **title**: Name of your Space.
17
+ - **emoji**: An optional emoji for the Space.
18
+ - **colorFrom**: Color to start the gradient.
19
+ - **colorTo**: Color to end the gradient.
20
+ - **sdk**: SDK you're using (e.g., `streamlit`, `gradio`).
21
+ - **sdk_version**: The version of the SDK.
22
+ - **app_file**: The name of your app file (e.g., `app.py`).
23
+
24
+ ## Example Usage
25
+ Here you can describe how users should interact with your Space, how to deploy, or any setup instructions they need.