Skip to content

The Leagueify roster service is responsible for managing player registration, team formation, and roster updates.

License

Notifications You must be signed in to change notification settings

Leagueify/roster

Repository files navigation

Roster Service

The Leagueify roster service is responsible for managing player registration, team formation, and roster updates. The Leagueify roster service uses Go using version 1.23.0.

Key Functions

  • Register players and maintain player profiles
  • Create and manage teams within leagues.
  • Assign players to teams.
  • Track roster changes

Development

Prerequisites

  • Docker is installed and running.

Getting Started

Local development of the Leagueify roster service uses docker for a consistent development environment. Running the Leagueify roster service locally can be accomplished using commands found in the Makefile. During local development changes will trigger a live reload, eliminating the requirement to restart the docker image manually. This is accomplished by using the wonderful tool air. The most common commands have been outlined below:

# start leagueify docker image
make start

# stop leagueify docker image removing attached volumes
make clean

The Leagueify roster service is ready for development once the banner output is visible within the terminal. By default the Leagueify roster service api docs are accessible at http://localhost:6504/roster/docs. The banner below was created using the Text to ASCII Art Generator by Patorjk.

leagueify-roster-1  |
leagueify-roster-1  | '||'      '||''''|      |      ..|'''.|  '||'  '|' '||''''|  '||' '||''''| '||' '|'
leagueify-roster-1  |  ||        ||  .       |||    .|'     '   ||    |   ||  .     ||   ||  .     || |
leagueify-roster-1  |  ||        ||''|      |  ||   ||    ....  ||    |   ||''|     ||   ||''|      ||
leagueify-roster-1  |  ||        ||        .''''|.  '|.    ||   ||    |   ||        ||   ||         ||
leagueify-roster-1  | .||.....| .||.....| .|.  .||.  ''|...'|    '|..'   .||.....| .||. .||.       .||.
leagueify-roster-1  |
leagueify-roster-1  | '||''|.    ..|''||    .|'''.|  |''||''| '||''''|  '||''|.
leagueify-roster-1  |  ||   ||  .|'    ||   ||..  '     ||     ||  .     ||   ||
leagueify-roster-1  |  ||''|'   ||      ||   ''|||.     ||     ||''|     ||''|'
leagueify-roster-1  |  ||   |.  '|.     || .     '||    ||     ||        ||   |.
leagueify-roster-1  | .||.  '|'  ''|...|'  |'....|'    .||.   .||.....| .||.  '|'
leagueify-roster-1  |

About

The Leagueify roster service is responsible for managing player registration, team formation, and roster updates.

Resources

License

Stars

Watchers

Forks

Packages

No packages published