Skip to content

Commit

Permalink
chore(docs/core): 2024-12-15 21:38:48
Browse files Browse the repository at this point in the history
Affected files:
content/Projects/GC/Modules/User.md
content/Projects/GC/Product/Requirement.md
content/Projects/GC/Terminologies/Audience.md
content/Projects/GC/Terminologies/Captains.md
content/Projects/GC/Terminologies/Matches.md
  • Loading branch information
zakhaev26 committed Dec 15, 2024
1 parent 8253e8f commit 03c973d
Show file tree
Hide file tree
Showing 5 changed files with 53 additions and 5 deletions.
16 changes: 11 additions & 5 deletions content/Projects/GC/Modules/User.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,13 @@
## Journey
- everyone starts in the application as unauthroized users
## Access Control
### Journey

## ERD
The application begins with users entering as **Unauthorized users**, referred to as the **[[Audience]]**. For players to onboard into the system, they must first register by providing specific details. These details are outlined in the **[[Requirement#^11b4bc|Player Registration Requirements]]**. Once registered, players become part of the pool from which [[Captains]] and admins can create and manage [[Team]], appoint [[Captains]], assign players to [[Squad]], and set up [[Match]]. This process helps in building the structure of the game, ensuring players are on boarded properly before they are involved in any team-based activities.

## Specs
### Access Control

- **Users**: Can create their own accounts and register by providing the required details, thereby onboarding themselves into the application.
- **Admins**: Have the authority to enable, disable, or delete user accounts as necessary. Admins also manage user access and can modify account statuses.
- **Users**: Can update their personal details after registration to ensure their profile remains accurate and up-to-date.
-
### ERD

#WIP
2 changes: 2 additions & 0 deletions content/Projects/GC/Product/Requirement.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,8 @@ Roles in the applications are:
| **SYSTEM** | Refers to programmatic actions and automated processes performed by the application, such as data updates, scheduled tasks, or system-generated changes. |
# **Player Registrations, Audience Access, and Profiles**

^11b4bc

Players will undergo a progressive registration process, ensuring their profiles are built and updated gradually as they engage with the application. This allows for a personalized experience, where information is captured over time based on the player's interaction with the platform.

During registration, players will be required to provide the following essential details:
Expand Down
11 changes: 11 additions & 0 deletions content/Projects/GC/Terminologies/Audience.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
In the context of the application, **Audience** refers to users who have not yet registered or logged in. These individuals have limited access to the platform, primarily allowing them to view general information, such as upcoming and past [[Match]]. They are considered "unauthorized" users in the system and cannot interact with features that require authentication, such as creating [[Team]], editing [[Profile]], or participating in [[Match]].

The Audience role is typically the first point of contact for users before they decide to register and become players. This status ensures that the system remains secure by restricting access to certain functionalities until a user has registered and logged in.

**Key Characteristics:**

- Can only view general match details and public content.
- Cannot modify or interact with the system's core functionalities (e.g., creating teams, joining squads).
- Transition to a "Player" status occurs after registration and successful onboarding.

This system allows for a seamless transition from passive users (audience) to active participants (players), with appropriate permissions granted as users engage more with the platform.
12 changes: 12 additions & 0 deletions content/Projects/GC/Terminologies/Captains.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
In the context of the application, **Captains** are elevated [[User|Players]] who hold the responsibility of leading and managing a [[Squad]] throughout the tournament. Captains play a role in [[Team]] formation and [[User|Player]] management. They are given special privileges, allowing them to approve or reject player requests to join their squad, and they are responsible for assembling a team from the pool of players within their squad.

Captains also have the authority to manage their team’s lineup for specific matches, ensuring that the right players are selected and that team details are kept up to date. They have the flexibility to edit their squad details, including adding or removing players, and they are accountable for the performance and coordination of the team during matches.

In addition to their role in player management, captains may also be involved in tactical decisions and can represent the team in official capacities during the match. They work closely with admins to ensure that the squad is properly represented and aligned with tournament rules and regulations.

**Key Responsibilities of Captains:**

- Approve or reject player requests to join their squad.
- Create and manage teams for specific matches.
- Edit squad details and manage player assignments.
- Lead the team during the tournament and make strategic decisions.
17 changes: 17 additions & 0 deletions content/Projects/GC/Terminologies/Matches.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
In the application, **[[Match]]** represent the core events in a tournament where [[Team|Teams]] compete against each other. A match is created by an admin and includes important details such as the teams involved, the squad members, venue, date, and status of the match. These details are managed throughout the match lifecycle, from scheduling to final results.

Admins have full control over the creation, editing, and deletion of matches, ensuring that match schedules are properly set, adjusted, or canceled if necessary. Once a match is created, it is made visible to the audience and users, allowing them to view upcoming and past match details, including the teams, venue, and date.

Matches also require the appointment of [[Umpire Assignment - Promote Player with TTL|Umpires]], who are responsible for updating scores and managing other game-related tasks. Umpires are selected from a pool of players by admins, based on FPP (Fair Play Policies) of GC and are given temporary umpire status, which expires after a set period.

### Key Match Lifecycle

- **Creation**: Admins create the match, defining teams, squads, venue, and date.
- **Status**: The match can be in various statuses such as "Scheduled", "In Progress", or "Completed".
- **Visibility**: Audience and users can view match details but cannot modify them.
- **Umpires**: Admins assign umpires to manage scores and officiate the match.

### Match Roles and Access Control

- **Admins**: Have full control over match creation, editing, and deletion.
- **Audience & Users**: Can view upcoming and past matches, but cannot modify any match details.

0 comments on commit 03c973d

Please sign in to comment.