Navigation
Back to Documentation

User Guide

Comprehensive step-by-step guide for all features of the Esports Dashboard

Table of Contents
Getting Started

Accessing the Application

  1. Open your web browser and navigate to: http://localhost:4000
  2. You'll see the login page

Logging In

  1. Enter your email address in the Email field
  2. Enter your password in the Password field
  3. Click the Sign In button

Demo Credentials:

  • Email: admin@esports.local
  • Password: password

First Login Experience

After logging in, you'll be redirected to the dashboard homepage. If you don't have an organization selected, you'll need to create or select one.

Dashboard Overview

Navigation Sidebar

The left sidebar provides quick access to all major features:

  • 🏢 Organizations - Manage your organizations
  • 📅 Seasons - Create and manage competition seasons
  • 👥 Teams - Manage teams and rosters
  • 🎮 Matches - Schedule and manage matches
  • 📊 Standings - View league standings
  • 📢 Announcements - View and create announcements
  • 🔔 Notifications - View your notifications

Organization Selector

At the top of the sidebar, you'll see the organization selector. Click it to:

  • Switch between organizations
  • Create a new organization

User Profile

At the bottom of the sidebar, click your profile to:

  • Access settings
  • Logout
Organizations

Organizations are the top-level containers for all your competition data. Each organization is completely isolated from others.

Viewing Organizations

  1. Click Organizations in the sidebar
  2. You'll see a grid of all organizations you have access to

Creating a New Organization

  1. Click Organizations in the sidebar
  2. Click the Create Organization button in the top right
  3. Fill in the form:
    • Organization Name (required): Enter a descriptive name
    • Slug (required): URL-friendly identifier (auto-generated from name if left empty)
    • Description (optional): Add details about your organization
  4. Click Create Organization
Seasons

Seasons represent a competition period (e.g., "Spring 2024", "Championship Season").

Creating a Season

  1. Click Seasons in the sidebar
  2. Click Create Season button
  3. Fill in the form with season name, dates, and game title
  4. Click Create Season
Teams

Creating a Team

  1. Click Teams in the sidebar
  2. Click Create Team button
  3. Select the season and fill in team details
  4. Click Create Team

Adding a Player to Roster

  1. Navigate to the team detail page
  2. Click + Add Player button
  3. Select a player profile, position, and jersey number
  4. Click Add Player
Matches

Creating a Match

  1. Click Matches in the sidebar
  2. Click Create Match button
  3. Select season, teams, scheduled time, and best-of setting
  4. Click Create Match

Submitting Match Results

When a match is ready for results:

  1. Navigate to the match detail page
  2. Scroll to the Submit Result section
  3. For each game in the best-of series, enter:
    • 1 for a win
    • 0 for a loss
  4. (Optional) Add notes about the match
  5. Click Submit Result

Example for Best-of-3:

  • Game 1: Enter 1 (win)
  • Game 2: Enter 0 (loss)
  • Game 3: Enter 1 (win)

Confirming Match Results

  1. Navigate to the match detail page
  2. Scroll to the Confirm Result section
  3. Review the submitted results
  4. Click Confirm Result to approve, or Dispute Result if there's an issue
Standings

Viewing Standings

  1. Click Standings in the sidebar
  2. Select a season from the dropdown
  3. View the standings table showing rank, team name, wins, losses, points, and win percentage

Standings update automatically when match results are confirmed.

Announcements

Creating an Announcement

  1. Click Announcements in the sidebar
  2. Click + New Announcement button
  3. Fill in title, content, and scope (organization-wide or season-specific)
  4. Optionally pin the announcement or schedule for later
  5. Click Create Announcement
Notifications

Notifications alert you to important events like match scheduling, result submissions, and disputes.

Viewing Notifications

  1. Click Notifications in the sidebar
  2. View all your notifications
  3. Click Mark read on any unread notification
Tips & Best Practices

Workflow Recommendations

  1. Start with Organizations: Create your organization first
  2. Create Seasons: Set up seasons before creating teams
  3. Build Teams: Create teams and add players to rosters
  4. Schedule Matches: Create matches between teams
  5. Submit Results: After matches, submit results promptly
  6. Confirm Results: Review and confirm submitted results
  7. Monitor Standings: Check standings regularly

Best Practices

  • Use descriptive names for clarity
  • Fill in descriptions to help team members understand
  • Submit results promptly to keep standings up to date
  • Use announcements to keep your organization informed
  • Check notifications to stay on top of pending actions