System Requirements Document (SRD)

Project Name: brave-cricket

1. Introduction

The brave-cricket project is a cricket scoring and management web application designed specifically for Ariyan_999's personal league, the S.P.L (Sasta Premier League). The system aims to provide a streamlined and user-friendly experience for managing teams, players, matches, and statistics, while offering a modern cricket-themed design. This document outlines the system requirements for the development of the application, ensuring it meets the needs of the league and delivers a seamless experience for the admin user.

2. System Overview

The brave-cricket system will serve as a centralized platform for managing cricket matches and league statistics. It will allow the admin to:

• Add and manage teams and players.
• Create matches and record live scores.
• Automatically update match statistics such as total score, overs, and wickets.
• Maintain a history of matches and player statistics.
• Generate points tables and leaderboards for Orange and Purple caps.

The system will feature a modern UI with a cricket-themed design, optimized for mobile devices and tailored for personal/private use.

3. Functional Requirements

As Admin:

• I should be able to add and manage multiple teams.
• I should be able to add and manage players (name, team, role, stats).
• I should be able to create matches between two teams.
• I should be able to use a live scoring system with buttons:
  • +1 run, +2 runs, +3 runs, +4 runs, +6 runs, wicket, wide, no ball.
• I should be able to automatically update:
  • Total score, overs, wickets.
• I should be able to save full match history.
• I should be able to view player statistics:
  • Total runs, strike rate, matches, wickets, economy.
• I should be able to view a points table system:
  • Matches played, wins, losses, points, net run rate.
• I should be able to view leaderboards:
  • Orange cap (most runs), Purple cap (most wickets).
• I should be able to log in via a simple admin-only login system.
• I should be able to access a dashboard with all stats.
• I should be able to view individual team pages.
• I should be able to view individual player profile pages.

4. User Personas

Admin

• Role: Sole user responsible for managing the league.
• Responsibilities: Adding teams and players, creating matches, recording live scores, viewing stats, and managing the league.
• Technical Expertise: Basic familiarity with web applications.

5. Visuals Colors and Theme

Color Palette

The design will feature a cricket-themed color palette inspired by the S.P.L (Sasta Premier League):

• Background: #E8F5E9 (Light Green)
• Surface: #1E88E5 (Bright Blue)
• Text: #212121 (Dark Gray)
• Accent: #FFC107 (Golden Yellow)
• Muted Tones: #B0BEC5 (Soft Gray)

Theme

The UI will incorporate cricket-related visuals, such as bats, balls, stumps, and pitch graphics, while maintaining a clean and modern aesthetic.

6. Signature Design Concept

Interactive Cricket Field Homepage

The homepage will feature an interactive cricket field design. Users will see a top-down view of a cricket pitch with animated players positioned on the field. Each section of the homepage will correspond to a specific area of the field:

• Team Management: Clicking on the pavilion opens the team management page.
• Player Profiles: Clicking on the players on the field opens individual player profiles.
• Live Scoring: The scoreboard at the top of the field will display live match updates.
• Points Table and Leaderboards: Clicking on the stands will show the points table and leaderboards.

Animations and Interactions

• Hover Effects: Hovering over players or sections will highlight them with subtle animations.
• Transitions: Smooth transitions between pages with cricket-themed animations (e.g., a ball rolling across the screen).
• Micro-Interactions: Buttons for scoring will have tactile animations, such as a bat hitting a ball.

This design will make the homepage visually engaging and instantly memorable, setting the tone for the entire application.

7. Non-Functional Requirements

• Performance: The system should load pages within 2 seconds on average.
• Scalability: Support up to 50 teams and 500 players.
• Security: Ensure secure admin login with encrypted credentials.
• Accessibility: Optimize for mobile devices and ensure compatibility with major browsers.
• Usability: Provide an intuitive interface with minimal learning curve.

8. Tech Stack

Frontend

• React for Web

Backend

• Python
• FastAPI

Database

• MySQL (with Alembic for migrations)

AI Models

• GPT 5.4 for user-friendly responses

AI Tools

• Langchain

Local Orchestration

• Docker
• docker-compose

9. Assumptions and Constraints

Assumptions

• The admin will be the sole user of the system.
• Only one match will be scored live at a time.
• The system will be used for personal/private league management.

Constraints

• The application will not support public access or multiple admin roles.
• The system will be optimized for mobile devices but primarily designed for web use.

10. Glossary

• S.P.L (Sasta Premier League): The personal cricket league managed by the admin.
• Orange Cap: Awarded to the player with the most runs in the league.
• Purple Cap: Awarded to the player with the most wickets in the league.
• Points Table: A table showing team rankings based on matches played, wins, losses, points, and net run rate.
• Strike Rate: A measure of a player's scoring efficiency (runs per 100 balls).
• Economy: A measure of a bowler's efficiency (runs conceded per over).