https://github.com/cmohan312002/pixel_prompteng
A fun and interactive Streamlit-based web app designed for students to test and improve their prompt engineering skills through three dynamic rounds of AI challenges. Participants craft creative prompts, reverse-engineer AI outputs, and tackle unique challenges — all while avoiding forbidden words and earning scores.
https://github.com/cmohan312002/pixel_prompteng
gemini genai llm python streamlit
Last synced: 2 months ago
JSON representation
A fun and interactive Streamlit-based web app designed for students to test and improve their prompt engineering skills through three dynamic rounds of AI challenges. Participants craft creative prompts, reverse-engineer AI outputs, and tackle unique challenges — all while avoiding forbidden words and earning scores.
- Host: GitHub
- URL: https://github.com/cmohan312002/pixel_prompteng
- Owner: cmohan312002
- Created: 2025-03-06T05:51:04.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-03-18T06:22:09.000Z (over 1 year ago)
- Last Synced: 2025-12-31T19:28:44.568Z (6 months ago)
- Topics: gemini, genai, llm, python, streamlit
- Language: Python
- Homepage: https://pixel-prompt.streamlit.app/
- Size: 105 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
---
# 🚀 Prompt Engineering Challenge – College Edition 🎮
A fun, interactive **Streamlit web app** where students can test their **prompt engineering skills** through **three dynamic AI-powered rounds**. Designed for **tech fests**, **workshops**, or **learning events**, this game challenges players to craft prompts, reverse-engineer outputs, and creatively respond — all while scoring based on multiple metrics.
---
## 🌟 Features
- 🎯 **Three Engaging Rounds**:
- **Round 1**: Forbidden Words Challenge – Craft prompts without using specific keywords.
- **Round 2**: Reverse Engineer the Prompt – Guess the prompt based on an AI-generated output.
- **Round 3**: Creative Challenge – Generate the most creative prompt to solve a unique challenge.
- 🤖 Powered by **Google Gemini API** for real-time AI responses.
- 📊 **Scoring System**:
- Evaluates **accuracy**, **creativity**, **clarity**, **efficiency**, and **rule compliance**.
- Uses AI to judge prompt relevance and award scores per round.
- 🔐 Secure API key handling using **Streamlit Secrets**.
- 🏆 Final results with detailed **score breakdown** and **review mode**.
---
## 🚀 Demo
Coming soon! (Add screenshots or a Streamlit Cloud link if hosted)
---
## 🛠️ Installation
1. **Clone the repository**:
```bash
git clone https://github.com/cmohan312002/Pixel_PromptEng.git
cd prompt-engineering-challenge
```
2. **Create a virtual environment** (optional but recommended):
```bash
python -m venv env
source env/bin/activate # On Windows: env\Scripts\activate
```
3. **Install dependencies**:
```bash
pip install -r requirements.txt
```
4. **Set up Streamlit Secrets for Gemini API key**:
- Create a `.streamlit/secrets.toml` file:
```toml
GEMINI_API_KEY = "your-gemini-api-key-here"
```
---
## ▶️ Run the App
```bash
streamlit run app.py
```
---
## 📁 Project Structure
```
📦 prompt-engineering-challenge/
┣ 📜 app.py # Main Streamlit app
┣ 📜 requirements.txt # Required Python packages
┣ 📁 .streamlit/ # Streamlit secrets configuration
┃ ┗ 📜 secrets.toml
```
---
## 📊 Scoring Logic
| Metric | Description |
|-------------------|-----------------------------------------------------------------------------|
| Accuracy | Relevance of AI response to the challenge question |
| Creativity | Unique word usage in prompt |
| Clarity | Balanced length and coherence |
| Efficiency | Prompt length optimization |
| Rule Compliance | Avoidance of forbidden words |
---
## 🙌 Contributing
Contributions, suggestions, and feature requests are welcome!
1. Fork the repository.
2. Create a new branch: `git checkout -b feature-name`.
3. Commit changes: `git commit -m 'Add new feature'`.
4. Push to branch: `git push origin feature-name`.
5. Open a pull request.
---
## 📜 License
This project is licensed under the [MIT License](LICENSE).
---
## 📬 Contact
Questions or feedback? Reach out via [email](mailto:cmohan312002@gmail.com) or open an [issue](https://github.com/cmohan312002/Pixel_PromptEng/issues).
---