Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
119 changes: 49 additions & 70 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,102 +1,81 @@
<img width="3188" height="1202" alt="frame (3)" src="https://github.com/user-attachments/assets/517ad8e9-ad22-457d-9538-a9e62d137cd7" />


# [Project Name] 🎯

# Roastberry-Pi 🎯

## Basic Details
### Team Name: [Name]

### Team Name: MAIN

### Team Members
- Team Lead: [Name] - [College]
- Member 2: [Name] - [College]
- Member 3: [Name] - [College]
- Team Lead: Yadu S Rajeev - TKM College of Engineering, Kollam
- Member 2: Vaishnav V Bishoy - TKM College of Engineering, Kollam

### Project Description
[2-3 lines about what your project does]
Face-to-Fruit is a comic-themed web app that hilariously matches your selfie to a fruit or veggie and roasts you with a savage, personalized caption.

### The Problem (that doesn't exist)
[What ridiculous problem are you solving?]
Not enough people know which vegetable or fruit they spiritually resemble. The world lacks official roast certificates from produce.

### The Solution (that nobody asked for)
[How are you solving it? Keep it fun!]
A face detection-powered web app that assigns you your "spirit produce" and roasts you based on your face's vibe. Download and share your Roast Certificate for ultimate bragging/shaming rights!

## Technical Details
### Technologies/Components Used
For Software:
- [Languages used]
- [Frameworks used]
- [Libraries used]
- [Tools used]
- JavaScript, HTML
- None (vanilla)
- face-api.js, Canvas API
- VSCode Live Server

For Hardware:
- [List main components]
- [List specifications]
- [List tools required]
- None required
- Any device with a browser & camera
- No additional tools needed

### Implementation
For Software:
# Installation
[commands]
## Important Note

# Run
[commands]
This app requires downloading the repository and running it locally in a browser using a local web server.
Due to use of AI models and browser file upload & security restrictions, this project will **NOT run properly if you simply open the HTML pages directly or via GitHub Pages**.

### Project Documentation
### Implementation
For Software:

# Screenshots (Add at least 3)
![Screenshot1](Add screenshot 1 here with proper name)
*Add caption explaining what this shows*

![Screenshot2](Add screenshot 2 here with proper name)
*Add caption explaining what this shows*

![Screenshot3](Add screenshot 3 here with proper name)
*Add caption explaining what this shows*

# Diagrams
![Workflow](Add your workflow/architecture diagram here)
*Add caption explaining your workflow*

For Hardware:

# Schematic & Circuit
![Circuit](Add your circuit diagram here)
*Add caption explaining connections*

![Schematic](Add your schematic diagram here)
*Add caption explaining the schematic*

# Build Photos
![Components](Add photo of your components here)
*List out all components shown*
# Installation
```bash
# 1. Clone repo and enter folder
git clone https://github.com/y-syntax/Roastberry-Pi.git
cd face-to-fruit

![Build](Add photos of build process here)
*Explain the build steps*
# 2. Download face-api.min.js from CDN or GitHub releases and place in folder

![Final](Add photo of final product here)
*Explain the final build*
# 3. Download face-api.js /models folder from official repo and place in folder

### Project Demo
# 4. Collect all images (potato.png, tomato.png, etc.) and put in /images/
Comment on lines +48 to +52
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛠️ Refactor suggestion

Clarify dependency download instructions

The installation steps mention downloading face-api.js and models but don't provide specific URLs or versions. This could confuse users setting up the project.

Consider adding specific URLs:

-# 2. Download face-api.min.js from CDN or GitHub releases and place in folder
+# 2. Download face-api.min.js (v0.22.2) from:
+# https://cdn.jsdelivr.net/npm/[email protected]/dist/face-api.min.js

-# 3. Download face-api.js /models folder from official repo and place in folder
+# 3. Download the models folder from:
+# https://github.com/justadudewhohacks/face-api.js/tree/master/weights
+# Place the entire 'weights' folder in your project root and rename it to 'models'
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
# 2. Download face-api.min.js from CDN or GitHub releases and place in folder
![Final](Add photo of final product here)
*Explain the final build*
# 3. Download face-api.js /models folder from official repo and place in folder
### Project Demo
# 4. Collect all images (potato.png, tomato.png, etc.) and put in /images/
# 2. Download face-api.min.js (v0.22.2) from:
# https://cdn.jsdelivr.net/npm/[email protected]/dist/face-api.min.js
# 3. Download the models folder from:
# https://github.com/justadudewhohacks/face-api.js/tree/master/weights
# Place the entire 'weights' folder in your project root and rename it to 'models'
# 4. Collect all images (potato.png, tomato.png, etc.) and put in /images/
🤖 Prompt for AI Agents
In README.md around lines 48 to 52, the instructions for downloading
face-api.min.js and the models folder lack specific URLs or version details,
which may confuse users. Update the steps to include exact URLs for downloading
face-api.min.js from a reliable CDN or GitHub releases page, and provide the
direct link to the official face-api.js models folder repository or release
version. This will clarify the dependencies and ensure users download the
correct files.

```
# Run
```bash
# Serve locally! (choose one)
python -m http.server 8000
# or use VSCode Live Server, or 'http-server' if you use node/npm
# Open http://localhost:8000/upload.html in your browser
```
# Project Documentation
### Screenshots
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue

Fix heading level increment

The heading jumps from h1 to h3. Headings should increment by one level at a time.

Apply this diff:

-### Screenshots
+## Screenshots
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
### Screenshots
## Screenshots
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)

62-62: Heading levels should only increment by one level at a time
Expected: h2; Actual: h3

(MD001, heading-increment)

🤖 Prompt for AI Agents
In README.md at line 62, the heading level jumps from h1 directly to h3, which
breaks proper heading hierarchy. Change the h3 heading "Screenshots" to h2 to
ensure the heading levels increment sequentially by one.

![Snippet of Uploading page](images/ss-upload.png)
![Snippet after Uploading image](images/ss-pic-upload.png)
![Snippet of Output page](images/ss-output.png)
![Certificate generated](images/Certificate.png)

# Project Demo
# Video
[Add your demo video link here]
*Explain what the video demonstrates*

# Additional Demos
[Add any extra demo materials/links]
[Drive link](https://drive.google.com/file/d/1sX8CidnZxZqFXOf_tAk_UBnlHtkjTS0t/view?usp=sharing)
Video shows: Upload process, comic analysis, result page, voice roast, certificate download and sharing.

## Team Contributions
- [Name 1]: [Specific contributions]
- [Name 2]: [Specific contributions]
- [Name 3]: [Specific contributions]
# Team Contributions
- Yadu S Rajeev: JavaScript AI logic, comic theming, CSS artwork, README, roast content, bug testing
- Vaishnav V Bishoy: UI/UX design, veggie array, certificate Canvas code, Image assets collection, roast content, bug testing

---
Made with ❤️ at TinkerHub Useless Projects
---
Made with ❤️ at TinkerHub Useless Projects

![Static Badge](https://img.shields.io/badge/TinkerHub-24?color=%23000000&link=https%3A%2F%2Fwww.tinkerhub.org%2F)
![Static Badge](https://img.shields.io/badge/UselessProjects--25-25?link=https%3A%2F%2Fwww.tinkerhub.org%2Fevents%2FQ2Q1TQKX6Q%2FUseless%2520Projects)



1 change: 1 addition & 0 deletions face-api.min.js

Large diffs are not rendered by default.

Binary file added images/Certificate.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/You_FaceToFruit_Certificate (1).png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/You_FaceToFruit_Certificate.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/bg.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/bittergourd.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/carrot.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/cucumber.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/drumstick.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/egg.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/eggplant.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/jackfruit.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/onion.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/pineapple.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/potato.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/pumpkin.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/recording.mp4
Binary file not shown.
Binary file added images/redchilli.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/ss-output.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/ss-pic-upload.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/ss-upload.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/tomato.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/watermelon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading