Skip to content

README.md

Latest commit

 

History

History
132 lines (94 loc) · 3.89 KB

README.md

File metadata and controls

132 lines (94 loc) · 3.89 KB

🎮 Rock Paper Scissors - Django Game (WIP) 🚀

Welcome to the Rock Paper Scissors game built using Python Django! This project is a Work in Progress (WIP) with exciting features planned for future updates. Stay tuned! 🌟

Screen Recording 2025-02-09 at 7 32 51 PM

📌 Project Overview

This game is designed for beginners who want to explore Django concepts while working on a fun project! , this project aims to introduce important backend concepts, including:

✅ Database Authentication
✅ Leaderboard System
✅ Kafka Event Streaming
✅ Redis Caching
✅ Real-time Multiplayer Mode
✅ AI Opponent & Difficulty Levels

🎯 Features

✅ Current Features:

  • 🎮 Classic Rock Paper Scissors Gameplay
  • 🔥 Lottie Animations for Smooth Visuals
  • 💰 Betting System for a Competitive Edge
  • 🎨 Modern UI/UX with Dark Gradient Theme
  • 📊 Basic Score Tracking

🔥 Upcoming Features:

  • 🛡️ User Authentication (Login/Signup)
  • 🏆 Leaderboard for Competitive Ranking
  • ⚡ Kafka Integration for Event Handling
  • ⚡ Redis Caching for Performance Boost
  • 📊 Match History & Statistics Tracking
  • 🧠 AI Opponent with Adaptive Strategies
  • 🌍 Multiplayer Mode with Real-time Updates

📂 Project Structure

rock-paper-scissors/
│── rps_game/                # Main Django app
│   ├── migrations/          # Database migrations
│   ├── static/              # Static files (CSS, JS, images)
│   │   ├── css/             # Stylesheets
│   │   ├── js/              # JavaScript logic
│   │   ├── images/          # Game assets
│   ├── templates/           # HTML templates
│   │   ├── base.html        # Base template
│   │   ├── game.html        # Main game UI
│   ├── views.py             # Game logic and API endpoints
│   ├── urls.py              # URL routing
│   ├── models.py            # Database models (To be added)
│   ├── forms.py             # Django forms (Future feature)
│
├── env/                     # Virtual environment (Recommended)
│   ├── bin/                 # Executables and scripts
│   ├── lib/                 # Installed Python libraries
│   ├── include/             # Header files
│
├── db.sqlite3               # SQLite database (Temporary for development)
├── manage.py                # Django management script
├── requirements.txt         # Dependencies list
├── README.md                # Project documentation

🛠️ Installation & Setup

1️⃣ Clone the Repository

git clone https://github.com/gaju91/python-django-rps.git
cd python-django-rps

2️⃣ Create a Virtual Environment (Recommended)

python -m venv env
source env/bin/activate  # On Windows use `env\Scripts\activate`

3️⃣ Install Dependencies

pip install -r requirements.txt

4️⃣ Run Migrations

python manage.py migrate

5️⃣ Start the Development Server

python manage.py runserver

Visit http://127.0.0.1:8000/ to play the game! 🎮

📚 Resources to Get Started

🤝 Contributing

Contributions are welcome! Feel free to fork the repository, submit pull requests, or suggest new features in the issues section. 🚀

📜 License

This project is licensed under the MIT License.