thisrudrapatel commited on
Commit
0362dec
Β·
verified Β·
1 Parent(s): 4b0f070

Update README.md

Browse files

Added Description

Files changed (1) hide show
  1. README.md +105 -3
README.md CHANGED
@@ -1,13 +1,115 @@
1
  ---
2
  title: WhatTheCode
3
- emoji: πŸ‘€
4
  colorFrom: gray
5
- colorTo: purple
6
  sdk: gradio
7
- sdk_version: 5.36.2
8
  app_file: app.py
9
  pinned: false
10
  license: mit
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
11
  ---
12
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
13
  Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
 
 
1
  ---
2
  title: WhatTheCode
3
+ emoji: πŸ’»
4
  colorFrom: gray
5
+ colorTo: indigo
6
  sdk: gradio
 
7
  app_file: app.py
8
  pinned: false
9
  license: mit
10
+ short_description: WhatTheCode πŸ‘€ is a fun, dev-centric solution explainer
11
+ ---
12
+ # WhatTheCode πŸ’»πŸ€―
13
+ _β€œBecause sometimes your own code feels like decoding an encrypted puzzle.”_
14
+
15
+ ---
16
+
17
+ ![Status](https://img.shields.io/badge/status-active-brightgreen.svg)
18
+ ![WhatTheCode Banner](https://img.shields.io/badge/Built%20With-Gradio%20-8A2BE2?style=flat-square)
19
+ ![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg)
20
+ ![Built with Groq + LLaMA 4](https://img.shields.io/badge/LLM-Meta--LLaMA_4-8A2BE2?style=flat-square&logo=meta)
21
+ ![Made by Rudra](https://img.shields.io/badge/made%20by-Rudra%20Patel-blueviolet)
22
+
23
+ ---
24
+
25
+ ## 🎯 Overview
26
+
27
+ **WhatTheCode πŸ‘€** is a fun, dev-centric Leetcode solution explainer that turns your raw code or problem description into clean, structured, and markdown-ready explanations β€” perfect for:
28
+
29
+ - Future self-reviews 🧠
30
+ - Leetcode Discuss posts πŸ’¬
31
+ - Understanding alien πŸ‘½ code
32
+ - Teaching others (or learning from your past logic)
33
+
34
+ No fluff. No academic jargon. Just structured, fun, markdown-formatted explanations that feel like a dev wrote them at 2 AM with pizza in hand and Stack Overflow tabs open.
35
+
36
  ---
37
 
38
+ ## πŸš€ Features
39
+
40
+ - ✍️ **Instant Markdown Explanations**
41
+ Paste your Leetcode code or problem, click a button β€” get a full explanation with:
42
+ - `## Intuition πŸ’‘`
43
+ - `## Approach πŸͺœ`
44
+ - `## Complexity ⏳`
45
+ - `## Code πŸ‘¨πŸ½β€πŸ’»`
46
+ - Optional: `## Alternate πŸ”`
47
+
48
+ - πŸ€– **Prompt Engineered Output**
49
+ Built on top of Groq + Meta-LLaMA 4, carefully tuned with a cheeky, dev-friendly tone.
50
+
51
+ - πŸ” **Alternate Solution Generator**
52
+ Got time? Ask it to cook up a different approach with one click.
53
+
54
+ - πŸ“¦ **Copy-Paste Ready Markdown Tab**
55
+ Designed for fast Leetcode Discuss uploads.
56
+
57
+ ---
58
+
59
+ ## πŸ› οΈ Tech Stack
60
+
61
+ - `Gradio ` β€” Frontend & interactivity
62
+ - `Python` β€” Core logic
63
+ - `Groq API` β€” LLM backend (Meta LLaMA-4)
64
+ - `.env` & HuggingFace Secrets β€” for secure prompt/key handling
65
+
66
+ ---
67
+
68
+ ## βš™οΈ How to Use Locally
69
+
70
+ 1. Clone the repo
71
+ ```bash
72
+ git clone https://huggingface.co/spaces/<your-username>/WhatTheCode
73
+ cd WhatTheCode
74
+ ```
75
+
76
+ 2. Install dependencies
77
+ ```bash
78
+ pip install -r requirements.txt
79
+ ```
80
+
81
+ 3. Add a `.env` file:
82
+ ```
83
+ GROQ_API_KEY=your_groq_key_here
84
+ MAGIC_PROMPT="Your prompt string..."
85
+ ```
86
+
87
+ 4. Run it locally:
88
+ ```bash
89
+ python app.py
90
+ ```
91
+
92
+ ---
93
+
94
+ ## πŸ“‘ Deploy on Hugging Face Spaces
95
+
96
+ 1. Push your repo to Hugging Face
97
+ 2. Go to `Settings > Secrets` and add:
98
+ - `GROQ_API_KEY`
99
+ - `PROMPT_ADVANCE` (optional)
100
+ 3. Hit β€œRestart Space” β€” and you're live!
101
+
102
+ ---
103
+
104
+ ## 🎨 App Metadata
105
+
106
+ ```yaml
107
+ title: WhatTheCode
108
+ emoji: πŸ‘€
109
+ colorFrom: gray
110
+ colorTo: purple
111
+ sdk: gradio
112
+ app_file: app.py
113
+ license: mit
114
  Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
115
+ ```