CoolFace
Apppublic

Miss-Jahnavi-2731/Telugu-Dialecto-Quiz

sourceHugging Faceupdated 1y agoView on Hugging Face
0likes
App README

๐ŸŽฎ Dialecto Quiz โ€“ Telugu Slang Edition

A fun and educational quiz web app built with Streamlit, designed to test and grow your knowledge of Telugu slang phrases. It also allows users to contribute their own phrases and uses Cohere AI to assist with auto-suggested meanings for new slang.


๐Ÿš€ Features

  • โ€”๐Ÿง  Randomized Quiz: Get 5 unique Telugu slang questions.
  • โ€”โœ๏ธ User Contributions: Submit your own slang phrases and meanings.
  • โ€”๐Ÿค– AI Integration: Auto-suggest slang meanings using Cohere AI.
  • โ€”๐Ÿ“Š Data Storage: Stores phrases in JSON and logs submissions in CSV.
  • โ€”๐ŸŽจ UI: Clean and fun interface with custom gradient design.

๐Ÿ“ฆ Tech Stack

  • โ€”Python
  • โ€”Streamlit
  • โ€”Pandas
  • โ€”Cohere AI API
  • โ€”JSON and CSV for data handling

๐Ÿ–ฅ๏ธ Demo

๐ŸŒ Try the live app: Live on huggingface spaces


๐Ÿง  How AI Integration Works

When users leave the "Meaning (in English)" field empty while contributing a phrase, Cohere AI intelligently generates a suggested English interpretation for that slang.

Example: ๐Ÿ—ฃ๏ธ Slang Phrase: thinnava ๐Ÿ’ก Suggested Meaning: Have you eaten?

๐Ÿ“ Folder Structure

โ”œโ”€โ”€ app.py                     # Main Streamlit app
โ”œโ”€โ”€ phrases.json              # Slang phrases and quiz data
โ”œโ”€โ”€ submissions.csv           # User-contributed slang
โ”œโ”€โ”€ requirements.txt          # Python dependencies
โ”œโ”€โ”€ README.md                 # Project overview and setup instructions
โ”œโ”€โ”€ REPORT.md                 # Detailed project report (final)
โ”œโ”€โ”€ CHANGELOG.md              # Development log of changes
โ”œโ”€โ”€ CONTRIBUTING.md           # Guidelines for contributors
โ”œโ”€โ”€ LICENSE                   # Open source license
โ”œโ”€โ”€ Home\_page.jpg            # UI image used in app

โš™๏ธ Setup Instructions

๐Ÿ”ง 1. Clone the Repository

bash
git clone https://code.swecha.org/Miss_Jahnavi04/telugu-dialecto-quiz.git
cd telugu-dialecto-quiz

๐Ÿ 2. Create Virtual Environment (Optional but recommended)

bash
python -m venv venv
source venv/bin/activate  # On Windows: venv\Scripts\activate

๐Ÿ“ฆ 3. Install Dependencies

bash
pip install -r requirements.txt

๐Ÿ”‘ 4. Add Cohere API Key

Create a folder named .streamlit and a file inside it called secrets.toml:

bash
mkdir .streamlit
touch .streamlit/secrets.toml

Paste the following into .streamlit/secrets.toml:

toml
[cohere]
api_key = "crHAuAsKyg6Xh4ouqIXScYWSri0y6ucDrsEKYh9k"
๐Ÿ“ You can get a free API key from Cohere.ai

โ–ถ๏ธ 5. Run the App

bash
streamlit run app.py

๐ŸŽฅ Demo Video

๐Ÿ“น Coming soon... (Record demo showing AI usage + quiz)


โœจ Contributors

  • โ€”๐Ÿ‘ฉโ€๐Ÿ’ป Jahnavi Guntuboina(Team Leader): Dividing the tasks, Checking deadlines and all.
  • โ€”Nitish Kumar B: UX & Testing
  • โ€”Sai Shashank Bejjanki: AI Integration
  • โ€”Yashwanth Myakala: Deployment & Hugging Face
  • โ€”Mukesh Chowdary Vinjam: Outreach & Corpus Growth
  • โ€”๐ŸŒŸ Powered by Cohere

๐Ÿ“œ License

This project is under the MIT License.


๐Ÿ’ฌ Have suggestions or slang to add?

Pull requests and contributions are welcome. Letโ€™s grow the Telugu slang corpus together!