Skip to content

README.md

Latest commit

 

History

History
82 lines (61 loc) · 1.93 KB

README.md

File metadata and controls

82 lines (61 loc) · 1.93 KB
Raw

🏴‍☠️ Treasure Hunt - Resonance'25

🎯 Overview

Treasure Hunt - Resonance'25 is an interactive game built using Streamlit where users log in, answer location-based questions, and progress through a treasure hunt by solving clues.

📌 Features

✅ User authentication (Login with username & password)
✅ Dynamic question-answer system
✅ Hints for tricky questions
✅ Session-based state management

🛠 Tech Stack

  • 🐍 Python
  • 🎨 Streamlit
  • 🔄 Requests (API calls)
  • 🔐 dotenv (For environment variable management)

🚀 Installation & Setup

1️⃣ Clone the Repository

git clone <repository-url>
cd <repository-folder>

2️⃣ Create a Virtual Environment (Optional but Recommended)

python -m venv venv
source venv/bin/activate  # On macOS/Linux
venv\Scripts\activate     # On Windows

3️⃣ Install Dependencies

pip install -r requirements.txt

4️⃣ Set Up Environment Variables

Create a .env file in the root directory and add your API URL:

API_URL=http://localhost:7153

5️⃣ Run the Application

streamlit run app.py

🎮 How to Play?

1️⃣ Login using your credentials.
2️⃣ Solve questions based on the location clues.
3️⃣ Submit answers to progress through the treasure hunt.
4️⃣ Need help? Click "Get Hint" for guidance.
5️⃣ Keep solving until you complete the hunt!

🔐 Security Notes

  • The .env file is ignored in .gitignore to keep API credentials safe.
  • Never expose sensitive data in the frontend.

🎯 Future Enhancements

🚀 Leaderboard integration
🚀 Timer-based challenge mode
🚀 Multiplayer support

🤝 Contributing

Feel free to fork, enhance, and submit a pull request!

Happy Hunting! 🏆