SyedWaqad commited on
Commit
2c14f5a
Β·
verified Β·
1 Parent(s): b55d92e

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +18 -10
README.md CHANGED
@@ -10,21 +10,29 @@ pinned: false
10
  license: mit
11
  ---
12
 
13
- # πŸŒ– EngGloss β€” Groq-Powered Chatbot with Gradio Frontend
14
 
15
- This project is a **Gradio-based AI chatbot** powered by the **Groq LLM API**.
16
- It allows you to interact with large language models like **LLaMA 3** via a simple and beautiful web interface.
 
 
 
 
17
 
18
- ---
19
 
20
- ## πŸš€ Features
21
 
22
- - 🎯 **Frontend:** Gradio (clean and responsive)
23
- - ⚑ **Backend:** Groq API (`llama3-8b-8192` model)
24
- - πŸ” Secure API key handling via `.env` or Hugging Face Secrets
25
- - 🧠 Persistent chat history per session
26
 
27
  ---
28
 
29
- ## 🧩 Project Structure
30
 
 
 
 
 
 
10
  license: mit
11
  ---
12
 
13
+ # πŸŒ– EngGloss β€” Groq-Powered Engineering Term Explainer
14
 
15
+ EngGloss is a small educational web app that explains engineering terms in a short, beginner-friendly structure:
16
+ - πŸ” Term
17
+ - πŸ“˜ Simple Explanation
18
+ - 🧠 Real-World Analogy
19
+ - πŸ“ Typical Formula (if any)
20
+ - πŸ—οΈ Practical Engineering Applications
21
 
22
+ It uses the Groq REST API (no Groq Python SDK) and Gradio for the UI β€” this avoids known SDK compatibility problems in some environments.
23
 
24
+ ---
25
 
26
+ ## Files
27
+ - `app.py` β€” Main Gradio application (calls Groq REST API via `requests`)
28
+ - `requirements.txt` β€” Required Python packages
29
+ - `.env.example` β€” Example env file for local testing
30
 
31
  ---
32
 
33
+ ## Local setup & test
34
 
35
+ 1. Create venv (recommended):
36
+ ```bash
37
+ python -m venv venv
38
+ source venv/bin/activate # Windows: venv\Scripts\activate