-
Notifications
You must be signed in to change notification settings - Fork 888
final repository change #33
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
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) | ||||||
 | ||||||
*Add caption explaining what this shows* | ||||||
|
||||||
 | ||||||
*Add caption explaining what this shows* | ||||||
|
||||||
 | ||||||
*Add caption explaining what this shows* | ||||||
|
||||||
# Diagrams | ||||||
 | ||||||
*Add caption explaining your workflow* | ||||||
|
||||||
For Hardware: | ||||||
|
||||||
# Schematic & Circuit | ||||||
 | ||||||
*Add caption explaining connections* | ||||||
|
||||||
 | ||||||
*Add caption explaining the schematic* | ||||||
|
||||||
# Build Photos | ||||||
 | ||||||
*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 | ||||||
|
||||||
 | ||||||
*Explain the build steps* | ||||||
# 2. Download face-api.min.js from CDN or GitHub releases and place in folder | ||||||
|
||||||
 | ||||||
*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/ | ||||||
``` | ||||||
# 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 | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 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
Suggested change
🧰 Tools🪛 markdownlint-cli2 (0.17.2)62-62: Heading levels should only increment by one level at a time (MD001, heading-increment) 🤖 Prompt for AI Agents
|
||||||
 | ||||||
 | ||||||
 | ||||||
 | ||||||
|
||||||
# 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 | ||||||
|
||||||
 | ||||||
 | ||||||
|
||||||
|
||||||
|
Large diffs are not rendered by default.
There was a problem hiding this comment.
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:
📝 Committable suggestion
🤖 Prompt for AI Agents