Skip to content

Commit 505fc0b

Browse files
authored
Merge pull request #94 from DivyaJain-DataAnalyst/main
update readme with gssoc logo
2 parents 5b0c3c3 + 562c095 commit 505fc0b

2 files changed

Lines changed: 207 additions & 47 deletions

File tree

README.md

Lines changed: 207 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,72 @@
11
# 🔧 Refixly – AI + AR Powered DIY Repair Assistant
22

3-
**Refixly** is an open-source web application that aims to empower users to repair household and electronic items using the power of **AI** and **Augmented Reality (AR)**. With an intelligent front end, computer vision support, and planned AR overlays, Refixly aspires to become a go-to tool for real-time object detection, repair tutorials, and DIY community collaboration.
3+
<p align="center">
4+
<img src="https://user-images.githubusercontent.com/74038190/212284100-561aa473-3905-4a80-b561-0d28506553ee.gif" width="100%">
5+
6+
![GSSoC'25](https://img.shields.io/badge/GirlScript%20Summer%20of%20Code-2025-orange?style=for-the-badge)
7+
8+
<img src="https://user-images.githubusercontent.com/74038190/212284100-561aa473-3905-4a80-b561-0d28506553ee.gif" width="100%">
9+
10+
[![Open Source](https://badges.frapsoft.com/os/v1/open-source.svg?v=103)](https://github.com/Bavanetha27/Refixly)
11+
12+
<img src="https://user-images.githubusercontent.com/74038190/212284100-561aa473-3905-4a80-b561-0d28506553ee.gif" width="100%">
13+
</p>
14+
15+
>**Refixly** is an open-source web application that aims to empower users to repair household and electronic items using the power of **AI** and **Augmented Reality (AR)**. With an intelligent front end, computer vision support, and planned AR overlays, Refixly aspires to become a go-to tool for real-time object detection, repair tutorials, and DIY community collaboration.
16+
17+
<img src="https://user-images.githubusercontent.com/74038190/212284100-561aa473-3905-4a80-b561-0d28506553ee.gif" width="100%">
18+
<div align="center">
19+
<img src="https://readme-typing-svg.herokuapp.com?font=Fira+Code&weight=600&size=24&duration=3000&pause=1000&color=00C853&center=true&vCenter=true&width=900&lines=Thanks+for+visiting+Refixly!+🙌;Start+the+repo+✅;Share+it+with+others+🌍;Contribute+and+grow+🛠️;Happy+Coding+✨!" alt="Thanks Banner Typing SVG" />
20+
</div>
21+
<img src="https://user-images.githubusercontent.com/74038190/212284100-561aa473-3905-4a80-b561-0d28506553ee.gif" width="150%">
22+
23+
**📊 Project Insights**
24+
25+
<table align="center">
26+
<thead align="center">
27+
<tr>
28+
<td><b>🌟 Stars</b></td>
29+
<td><b>🍴 Forks</b></td>
30+
<td><b>🐛 Issues</b></td>
31+
<td><b>🔔 Open PRs</b></td>
32+
<td><b>🔕 Closed PRs</b></td>
33+
<td><b>🛠️ Languages</b></td>
34+
<td><b>👥 Contributors</b></td>
35+
</tr>
36+
</thead>
37+
<tbody>
38+
<tr>
39+
<td><img alt="Stars" src="https://img.shields.io/github/stars/Bavanetha27/Refixly?style=flat&logo=github"/></td>
40+
<td><img alt="Forks" src="https://img.shields.io/github/forks/Bavanetha27/Refixly?style=flat&logo=github"/></td>
41+
<td><img alt="Issues" src="https://img.shields.io/github/issues/Bavanetha27/Refixly?style=flat&logo=github"/></td>
42+
<td><img alt="Open PRs" src="https://img.shields.io/github/issues-pr/Bavanetha27/Refixly?style=flat&logo=github"/></td>
43+
<td><img alt="Closed PRs" src="https://img.shields.io/github/issues-pr-closed/Bavanetha27/Refixly?style=flat&color=critical&logo=github"/></td>
44+
<td><img alt="Languages Count" src="https://img.shields.io/github/languages/count/Bavanetha27/Refixly?style=flat&color=green&logo=github"></td>
45+
<td><img alt="Contributors Count" src="https://img.shields.io/github/contributors/Bavanetha27/Refixly?style=flat&color=blue&logo=github"/></td>
46+
</tr>
47+
</tbody>
48+
</table>
449

5-
---
50+
<img src="https://user-images.githubusercontent.com/74038190/212284100-561aa473-3905-4a80-b561-0d28506553ee.gif" width="150%">
51+
52+
![GSSoC Logo](/Refixly/client/public/gssoc%20logo.png)
53+
54+
**🌟 Exciting News...**
55+
56+
🚀 This project is now an official part of GirlScript Summer of Code – GSSoC'25! 💃🎉💻 We're thrilled to welcome contributors from all over India and beyond to collaborate, build, and grow Refixly! Let’s make learning and career development smarter – together! 🌟👨‍💻👩‍💻
57+
58+
👩‍💻 GSSoC is one of India’s **largest 3-month-long open-source programs** that encourages developers of all levels to contribute to real-world projects 🌍 while learning, collaborating, and growing together. 🌱
59+
60+
🌈 With **mentorship, community support**, and **collaborative coding**, it's the perfect platform for developers to:
61+
62+
- ✨ Improve their skills
63+
- 🤝 Contribute to impactful projects
64+
- 🏆 Get recognized for their work
65+
- 📜 Receive certificates and swag!
66+
67+
🎉 **I can’t wait to welcome new contributors** from GSSoC 2025 to this Refixly project family! Let's build, learn, and grow together — one commit at a time. 🔥👨‍💻👩‍💻
68+
69+
<img src="https://user-images.githubusercontent.com/74038190/212284100-561aa473-3905-4a80-b561-0d28506553ee.gif" width="100%">
670

771
<details>
872
<summary><strong>📑 Table of Contents</strong></summary>
@@ -18,12 +82,9 @@
1882
- [📄 License](#-license)
1983
- [🙌 Acknowledgements](#-acknowledgements)
2084
- [📬 Contact](#-contact)
21-
22-
2385
</details>
2486

25-
---
26-
87+
![-----------------------------------------------------](https://raw.githubusercontent.com/andreasbm/readme/master/assets/lines/rainbow.png)
2788

2889
## 🎯 Project Vision
2990

@@ -36,7 +97,7 @@ Refixly's ultimate goal is to allow users to:
3697

3798
This repository includes the **homepage UI**, the **initial backend setup**, and is open for community contributions.
3899

39-
---
100+
![-----------------------------------------------------](https://raw.githubusercontent.com/andreasbm/readme/master/assets/lines/rainbow.png)
40101

41102
## 📦 Tech Stack Overview
42103

@@ -53,7 +114,7 @@ Here’s a complete breakdown of the technologies used (or planned) for Refixly.
53114
| **WebRTC / MediaDevices API** | Accessing webcam for live detection |
54115
| **TensorFlow.js** | In-browser ML (e.g., object detection using COCO-SSD) |
55116

56-
---
117+
![-----------------------------------------------------](https://raw.githubusercontent.com/andreasbm/readme/master/assets/lines/rainbow.png)
57118

58119
### 🛠️ Backend (Node.js + Express)
59120

@@ -65,34 +126,34 @@ Here’s a complete breakdown of the technologies used (or planned) for Refixly.
65126
| **Mongoose** | ODM for MongoDB to structure and manage data schemas |
66127
| **YouTube Data API v3** | Fetch video tutorials based on object detection |
67128

68-
---
129+
![-----------------------------------------------------](https://raw.githubusercontent.com/andreasbm/readme/master/assets/lines/rainbow.png)
69130

70-
### 🔐 Authentication (Planned)
131+
***🔐 Authentication (Planned)***
71132

72133
| Tech | Purpose |
73134
|-----------------------|---------|
74135
| **Firebase Auth** | Secure user login (email/password, Google sign-in) |
75136

76-
---
137+
![-----------------------------------------------------](https://raw.githubusercontent.com/andreasbm/readme/master/assets/lines/rainbow.png)
77138

78-
### 🕶️ AR Integration (Future Enhancement)
139+
***🕶️ AR Integration (Future Enhancement)***
79140

80141
| Tech | Purpose |
81142
|-----------------------|---------|
82143
| **Zappar WebAR SDK** | Lightweight JavaScript AR overlay (WebXR-compatible) |
83144
| **8thWall** | Commercial AR SDK (if free tier needed for advanced features) |
84145

85-
---
146+
![-----------------------------------------------------](https://raw.githubusercontent.com/andreasbm/readme/master/assets/lines/rainbow.png)
86147

87-
### 📦 Dev Tools & Hosting
148+
***📦 Dev Tools & Hosting***
88149

89150
| Tool/Service | Purpose |
90151
|-------------------|---------|
91152
| **Vercel** | Frontend hosting with GitHub CI/CD integration (free tier) |
92153
| **Render** | Backend hosting for Node.js server (free tier) |
93154
| **Thunder Client / Postman** | Local API testing |
94155

95-
---
156+
![-----------------------------------------------------](https://raw.githubusercontent.com/andreasbm/readme/master/assets/lines/rainbow.png)
96157

97158
## 📁 Project Structure
98159

@@ -109,9 +170,9 @@ refixly/
109170
├── public/ # Static files (logo, manifest, favicon)
110171
├── README.md
111172
├── .env.example
112-
````
173+
```
113174

114-
---
175+
![-----------------------------------------------------](https://raw.githubusercontent.com/andreasbm/readme/master/assets/lines/rainbow.png)
115176

116177
## 🚀 Getting Started
117178

@@ -149,7 +210,6 @@ VITE_FIREBASE_STORAGE_BUCKET=your_storage_bucket
149210
VITE_FIREBASE_MESSAGING_SENDER_ID=your_sender_id
150211
VITE_FIREBASE_APP_ID=your_app_id
151212
VITE_MEASUREMENT_ID=your_measurement_id
152-
153213
```
154214

155215
Create a `.env` file in `/server`:
@@ -165,13 +225,14 @@ YOUTUBE_API_KEY=your_youtube_api_key
165225
```bash
166226
npm run dev
167227
```
228+
168229
### 5. Run Backend Server
169230

170231
```bash
171232
node server.js
172233
```
173234

174-
---
235+
![-----------------------------------------------------](https://raw.githubusercontent.com/andreasbm/readme/master/assets/lines/rainbow.png)
175236

176237
## 🧠 AI Model (Planned)
177238

@@ -181,53 +242,48 @@ We will use **TensorFlow\.js** with **COCO-SSD** for in-browser object detection
181242
* Runs in user browser for speed and privacy
182243
* Can be extended to YOLOv8 (with server hosting)
183244

184-
---
245+
![-----------------------------------------------------](https://raw.githubusercontent.com/andreasbm/readme/master/assets/lines/rainbow.png)
185246

186247
## 🌐 Live Demo
187248

188-
> 🔗 [https://refixly.vercel.app](https://refixly.vercel.app)
249+
>🔗 [https://refixly.vercel.app](https://refixly.vercel.app)
189250
190-
---
251+
![-----------------------------------------------------](https://raw.githubusercontent.com/andreasbm/readme/master/assets/lines/rainbow.png)
191252

192253
## 🧑‍💻 How to Contribute
193254

194255
We welcome open source contributors to build Refixly together!
195256

196-
### 📌 Contribution Steps:
257+
***📌 Contribution Steps:***
197258

198-
1. Fork this repository
199-
2. Create a branch: `git checkout -b feature/your-feature-name`
200-
3. Make your changes
201-
4. Commit: `git commit -m "Added X feature"`
202-
5. Push to your fork
203-
6. Create a Pull Request
259+
* Fork this repository
260+
* Create a branch: `git checkout -b feature/your-feature-name`
261+
* Make your changes
262+
* Commit: `git commit -m "Added X feature"`
263+
* Push to your fork
264+
* Create a Pull Request
204265

205-
### 📖 Good First Issues
266+
![-----------------------------------------------------](https://raw.githubusercontent.com/andreasbm/readme/master/assets/lines/rainbow.png)
267+
268+
***📖 Good First Issues***
206269

207270
Check the [Issues](https://github.com/yourusername/refixly/issues) tab for beginner-friendly contributions like:
208271

209-
* Add "About" or "Tutorials" pages
272+
*Add "About" or "Tutorials" pages
210273
* Setup MongoDB models
211274
* Create AR component placeholder
212275
* Integrate TensorFlow\.js
213276

214-
---
215-
216-
## ✅ Guidelines
217-
218-
* Follow consistent naming and code formatting
219-
* Use comments where necessary
220-
* Keep PRs focused and well-explained
221-
* Respect the community — be kind and constructive ❤️
222-
223-
---
277+
![-----------------------------------------------------](https://raw.githubusercontent.com/andreasbm/readme/master/assets/lines/rainbow.png)
224278

225-
## 📄 License
279+
**✅ Guidelines**
226280

227-
This project is licensed under the **MIT License**.
228-
See the [LICENSE](LICENSE) file for details.
281+
- Follow consistent naming and code formatting
282+
- Use comments where necessary
283+
- Keep PRs focused and well-explained
284+
- Respect the community — be kind and constructive ❤️
229285

230-
---
286+
![-----------------------------------------------------](https://raw.githubusercontent.com/andreasbm/readme/master/assets/lines/rainbow.png)
231287

232288
## 🙌 Acknowledgements
233289

@@ -240,14 +296,118 @@ See the [LICENSE](LICENSE) file for details.
240296
* [Vercel](https://vercel.com)
241297
* [Firebase](https://firebase.google.com)
242298

243-
---
299+
![-----------------------------------------------------](https://raw.githubusercontent.com/andreasbm/readme/master/assets/lines/rainbow.png)
244300

245301
## 📬 Contact
246302

247303
* 🧑‍💻 Maintainer: [Bavanetha M R](https://github.com/Bavanetha27)
248304
* 📧 Email: [bavanethamr@gmail.com](mailto:bavanethamr@gmail.com)
249305

250-
---
306+
<img src="https://user-images.githubusercontent.com/74038190/212284100-561aa473-3905-4a80-b561-0d28506553ee.gif" width="100%">
307+
308+
**📜 Code of Conduct**
309+
310+
Please refer to the [`Code of Conduct`](https://github.com/Bavanetha27/Refixly/blob/main/CODE_OF_CONDUCT.md) for details on contributing guidelines and community standards.
311+
312+
<img src="https://user-images.githubusercontent.com/74038190/212284100-561aa473-3905-4a80-b561-0d28506553ee.gif" width="100%">
313+
314+
**🤝👤 Contribution Guidelines**
315+
316+
We love our contributors! If you'd like to help, please check out our [`CONTRIBUTE.md`](https://github.com/Bavanetha27/Refixly/blob/main/CONTRIBUTING.md) file for guidelines.
317+
318+
>Thank you once again to all our contributors who has contributed to **Refixly!** Your efforts are truly appreciated. 💖👏
319+
320+
<!-- Contributors badge (auto-updating) -->
321+
322+
[![Contributors](https://img.shields.io/github/contributors/Bavanetha27/Refixly?style=for-the-badge)](https://github.com/Bavanetha27/Refixly/graphs/contributors)
323+
324+
<!-- Contributors avatars (auto-updating) -->
325+
<p align="left">
326+
<a href="https://github.com/Bavanetha27/Refixly/graphs/contributors">
327+
<img src="https://contrib.rocks/image?repo=Bavanetha27/Refixly" alt="Contributors" />
328+
</a>
329+
</p>
330+
331+
See the full list of contributors and their contributions on the [`GitHub Contributors Graph`](https://github.com/Bavanetha27/Refixly/graphs/contributors).
332+
333+
<h2 align="center">
334+
<p style="font-family:var(--ff-philosopher);font-size:3rem;"><b> Show some <img src="https://raw.githubusercontent.com/Tarikul-Islam-Anik/Animated-Fluent-Emojis/master/Emojis/Smilies/Red%20Heart.png" alt="Red Heart" width="40" height="40" /> by starring this awesome repository!
335+
</p>
336+
</h2>
337+
338+
<img src="https://user-images.githubusercontent.com/74038190/212284100-561aa473-3905-4a80-b561-0d28506553ee.gif" width="150%">
339+
340+
**💡 Suggestions & Feedback**
341+
342+
Feel free to open issues or discussions if you have any feedback, feature suggestions, or want to collaborate!
343+
344+
<img src="https://user-images.githubusercontent.com/74038190/212284100-561aa473-3905-4a80-b561-0d28506553ee.gif" width="150%">
345+
346+
**🙌 Support & Star**
347+
348+
***If you find this project helpful, please give it a star ⭐ to support more such educational initiatives!***
349+
350+
<img src="https://user-images.githubusercontent.com/74038190/212284100-561aa473-3905-4a80-b561-0d28506553ee.gif" width="100%">
351+
352+
**📄 License**
353+
354+
This project is licensed under the MIT License - see the [`License`](https://github.com/Bavanetha27/Refixly/blob/main/LICENSE) file for details.
355+
356+
<img src="https://user-images.githubusercontent.com/74038190/212284100-561aa473-3905-4a80-b561-0d28506553ee.gif" width="150%">
357+
358+
**⭐ Stargazers**
359+
360+
<div align="center">
361+
<a href="https://github.com/Bavanetha27/Refixly/stargazers">
362+
<img src="https://reporoster.com/stars/Bavanetha27/Refixly?type=svg&limit=100&names=false" alt="Stargazers" />
363+
</a>
364+
</div>
365+
366+
<img src="https://user-images.githubusercontent.com/74038190/212284100-561aa473-3905-4a80-b561-0d28506553ee.gif" width="150%">
367+
368+
**🍴 Forkers**
369+
370+
<div align="center">
371+
<a href="https://github.com/Bavanetha27/Refixly/network/members">
372+
<img src="https://reporoster.com/forks/Bavanetha27/Refixly?type=svg&limit=100&names=false" alt="Forkers" />
373+
</a>
374+
375+
<img src="https://user-images.githubusercontent.com/74038190/212284100-561aa473-3905-4a80-b561-0d28506553ee.gif" width="150%">
376+
377+
<h2>🧑‍💻Project Admin:</h2>
378+
<table>
379+
<tr>
380+
<td align="center">
381+
<a href="https://github.com/Bavanetha27"><img src="https://avatars.githubusercontent.com/u/204599109?v=4" height="140px" width="140px" alt="Bavanetha M.R"></a><br><sub><b>Bavanetha M.R</b><br><a href="https://www.linkedin.com/in/bavanethamr/"><img src="https://github-production-user-asset-6210df.s3.amazonaws.com/73993775/278833250-adb040ea-e3ef-446e-bcd4-3e8d7d4c0176.png" width="45px" height="45px"></a></sub>
382+
</td>
383+
</tr>
384+
</table>
385+
386+
<img src="https://user-images.githubusercontent.com/74038190/212284100-561aa473-3905-4a80-b561-0d28506553ee.gif" width="100%">
387+
388+
**👨‍🏫 Mentors – Refixly (GSSoC'25)**
389+
390+
| Role | Name | GitHub Profile | LinkedIn Profile |
391+
| ------------- | ------------------ | --------------------------------------------------- | ----------------------------------------------------------------------- |
392+
| Mentor 1 | Pratyaksh | [PRATYAKSH15](https://github.com/PRATYAKSH15) | [pratyaksh](https://www.linkedin.com/in/pratyaksh-989922256/) |
393+
394+
<img src="https://user-images.githubusercontent.com/74038190/212284100-561aa473-3905-4a80-b561-0d28506553ee.gif" width="100%">
395+
396+
<h1 align="center"><img src="https://raw.githubusercontent.com/Tarikul-Islam-Anik/Animated-Fluent-Emojis/master/Emojis/Travel%20and%20places/Glowing%20Star.png" alt="Glowing Star" width="25" height="25" /> Give us a Star and let's make magic! <img src="https://raw.githubusercontent.com/Tarikul-Islam-Anik/Animated-Fluent-Emojis/master/Emojis/Travel%20and%20places/Glowing%20Star.png" alt="Glowing Star" width="25" height="25" /></h1>
397+
398+
<p align="center">
399+
<img src="https://raw.githubusercontent.com/Tarikul-Islam-Anik/Animated-Fluent-Emojis/master/Emojis/Objects/Mirror%20Ball.png" alt="Mirror Ball" width="150" height="150" />
400+
</p>
401+
402+
<img src="https://user-images.githubusercontent.com/74038190/212284100-561aa473-3905-4a80-b561-0d28506553ee.gif" width="150%">
403+
404+
**👨‍💻 Built with ❤️ by Refixly Team**
405+
406+
**❤️ Bavanetha M.R and Contributors ❤️** [open an issue](https://github.com/Bavanetha27/Refixly/issues) | [Watch Demo](https://refixly.vercel.app/)
407+
408+
<img src="https://capsule-render.vercel.app/api?type=waving&color=gradient&height=65&section=footer"/>
409+
410+
>**Ready to show off your coding achievements? Get started with Refixly today! 🚀**
251411
252412
> 🛠️ *Refixly – Let’s fix the future, one repair at a time.*
253413

client/public/gssoc logo.png

129 KB
Loading

0 commit comments

Comments
 (0)