Skip to content

README.md

Latest commit

 

History

History
62 lines (50 loc) · 2.9 KB

README.md

File metadata and controls

62 lines (50 loc) · 2.9 KB

🦘 Kangaroo Code

Kangaroo Code is a high-impact, full-stack cricket management platform designed to digitize the end-to-end cricket workflow. From scheduling fixtures to ball-by-ball live scoring and deep performance analysis, it replaces manual scorekeeping with a robust, automated system that ensures data integrity and real-time engagement.

🚀 Objective & Problem Solved

Kangaroo Code addresses the complexity of managing real-world cricket operations. It supports team creation, fixture scheduling, and role-based operations, eliminating the need for manual record-keeping through automated result declarations and persistent data storage.

✨ Key Features

  • Ball-by-Ball Live Scoring: Real-time updates for all participants with broadcast-style scorecards.
  • Real-Time Telemetry: Powered by WebSockets (Socket.io) for millisecond-latency score updates.
  • Player Portfolios: Personal dashboards for every player to analyze their career statistics and match performances.
  • Match Management: Streamlined scheduling, toss management, and automated result calculation.
  • Role-Based Access: Specialized controls for Captains, Umpires, and Players.
  • Audit Trail: Full correction history to ensure data integrity during concurrent scoring.

🛠️ Technology Stack

🏗️ Architecture & Methodology

Kangaroo Code is built with a focus on consistency and performance:

  • Normalized Schema: A robust PostgreSQL schema ensures data consistency across teams, matches, and players.
  • Idempotent Event Model: Scoring logic is designed to be idempotent, handling concurrent updates without data corruption.
  • Hybrid Intelligent Architecture: Combines traditional relational data management with real-time event streaming.

🏁 Getting Started

Prerequisites

  • Node.js (v18+)
  • PostgreSQL database
  • Google OAuth credentials (optional for social login)

Installation

  1. Clone the repository:

    git clone https://github.com/Papun1111/Kangaroo_Code.git
cd Kangaroo_Code

  2. Backend Setup:

    cd backend
npm install
# Create a .env file based on .env.example
npx prisma migrate dev
npm run dev

  3. Frontend Setup:

    cd ../frontend
npm install
# Create a .env.local file based on .env.example
npm run dev

📜 License

This project is licensed under the MIT License - see the LICENSE file for details.