Skip to content

Patch 1 #32

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.

Sign up for GitHub

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

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Patch 1 #32

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8340693
Update README.md
sinan4367 Aug 2, 2025
7509a9d
Update README.md
sinan4367 Aug 2, 2025
15499d4
Update README.md
sinan4367 Aug 2, 2025
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
80 changes: 29 additions & 51 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,96 +1,74 @@
<img width="3188" height="1202" alt="frame (3)" src="https://github.com/user-attachments/assets/517ad8e9-ad22-457d-9538-a9e62d137cd7" />

git clone:
https://github.com/sinan4367/chittappan_advice
# Chittappan_advice 🎯

# [Project Name] 🎯

website url hosted on vercel:
https://chittappan-advice.vercel.app/

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


### Team Members
- Team Lead: [Name] - [College]
- Member 2: [Name] - [College]
- Member 3: [Name] - [College]
- Team Lead: Muhammed sinan m - TKM college of engineering
- Member 2: sreerag - TKM college of engineering

### Project Description
[2-3 lines about what your project does]
Chittappan_Advice is a hilariously useless yet fun web app where users upload a palm photo, enter their details, and receive wildly entertaining AI-powered future predictions. Think of it as the digital version of that one uncle who always gives unsolicited advice — except powered by Google Gemini!

### The Problem (that doesn't exist)
[What ridiculous problem are you solving?]
People aren’t getting enough free and completely unscientific predictions about their future. How will they know if they’ll meet a cat tomorrow or become a dance analyst at the FIFA World Cup?

### The Solution (that nobody asked for)
[How are you solving it? Keep it fun!]
By combining palm photos, user details, and Gemini AI, we deliver quirky, point‑wise future predictions that are as accurate as your horoscope app — but 10x funnier.

## Technical Details
### Technologies/Components Used
For Software:
- [Languages used]
- [Frameworks used]
- [Libraries used]
- [Tools used]
Languages: JavaScript, JSX
Frameworks: React + Vite
Styling: Tailwind CSS
AI Model: Google Gemini API (gemini-1.5-flash)
Deployment: Vercel

For Hardware:
- [List main components]
- [List specifications]
- [List tools required]
None (unless you count the user’s hand ✋)

### Implementation
For Software:
# Installation
[commands]
git clone https://github.com/yourusername/chittappan_advice.git
cd chittappan_advice
npm install

# Run
[commands]
npm run dev

Comment on lines 42 to 49
Copy link

Choose a reason for hiding this comment

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

🛠️ Refactor suggestion

Fix heading-level jump that breaks MD001

# Installation / # Run restart the hierarchy under an H3 (“### Implementation”). Drop them to H4 (or lower) to keep incremental order.

-# Installation
+#### Installation
 ...
-# Run
+#### Run
📝 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
# Installation
[commands]
git clone https://github.com/yourusername/chittappan_advice.git
cd chittappan_advice
npm install
# Run
[commands]
npm run dev
#### Installation
git clone https://github.com/yourusername/chittappan_advice.git
cd into yourusername/chittappan_advice
npm install
#### Run
npm run dev
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)

43-43: Bare URL used

(MD034, no-bare-urls)

🤖 Prompt for AI Agents 
In README.md around lines 42 to 49, the headings "Installation" and "Run" use H1
level (#) which breaks the markdown heading hierarchy after an H3 heading.
Change these headings to H4 (####) or a lower level to maintain proper
incremental heading order and fix the MD001 linting error.

### Project Documentation
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*
Landing page where the magic begins — upload your palm and see your destiny.
<img width="1919" height="867" alt="image" src="https://github.com/user-attachments/assets/71ca5392-382b-4859-875a-11c4e23f0726" />

![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*
# Diagrams
User uploads palm → Gemini analyzes (pretends to) → Returns hilarious predictions

# Build Photos
![Components](Add photo of your components here)
*List out all components shown*

![Build](Add photos of build process here)
*Explain the build steps*

![Final](Add photo of final product here)
*Explain the final build*

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

# Additional Demos
[Add any extra demo materials/links]

## Team Contributions
- [Name 1]: [Specific contributions]
- [Name 2]: [Specific contributions]
- [Name 3]: [Specific contributions]
- muhammed sinan m: user interface design using react ,tailwind css
- sreerag vs: gemini api integration


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