Skip to content

The Leagueify league service is responsible for managing league-specific operations and rules.

License

Notifications You must be signed in to change notification settings

Leagueify/league

Repository files navigation

League Service

The Leagueify league service is responsible for managing league-specific operations and rules. The Leagueify league service uses Go using version 1.23.0.

Key Functions

  • Create and manage individual leagues and their seasons.
  • Define league rules, schedules, and standings.
  • Coordinate with the Roster and Statistics services for player and team information.

Development

Prerequisites

  • Docker is installed and running.

Getting Started

Local development of the Leagueify league service uses docker for a consistent development environment. Running the Leagueify league 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 league service is ready for development once the banner output is visible within the terminal. By default the Leagueify league service api docs are accessible at http://localhost:6503/league/docs. The banner below was created using the Text to ASCII Art Generator by Patorjk.

leagueify-league-1  |
leagueify-league-1  | '||'      '||''''|      |      ..|'''.|  '||'  '|' '||''''|  '||' '||''''| '||' '|'
leagueify-league-1  |  ||        ||  .       |||    .|'     '   ||    |   ||  .     ||   ||  .     || |
leagueify-league-1  |  ||        ||''|      |  ||   ||    ....  ||    |   ||''|     ||   ||''|      ||
leagueify-league-1  |  ||        ||        .''''|.  '|.    ||   ||    |   ||        ||   ||         ||
leagueify-league-1  | .||.....| .||.....| .|.  .||.  ''|...'|    '|..'   .||.....| .||. .||.       .||.
leagueify-league-1  |
leagueify-league-1  | '||'      '||''''|      |      ..|'''.|  '||'  '|' '||''''|
leagueify-league-1  |  ||        ||  .       |||    .|'     '   ||    |   ||  .
leagueify-league-1  |  ||        ||''|      |  ||   ||    ....  ||    |   ||''|
leagueify-league-1  |  ||        ||        .''''|.  '|.    ||   ||    |   ||
leagueify-league-1  | .||.....| .||.....| .|.  .||.  ''|...'|    '|..'   .||.....|
leagueify-league-1  |

About

The Leagueify league service is responsible for managing league-specific operations and rules.

Resources

License

Stars

Watchers

Forks

Packages

No packages published