organization

Organization Service

The Leagueify organization service is responsible for managing organizations that may oversee multiple leagues. The Leagueify organization service uses Go using version 1.23.0.

Key Functions

• Create and manage organizations.
• Assign administrators and roles within organizations.
• Manage leagues associated with an organization.

Development

Prerequisites

• Docker is installed and running.

Getting Started

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

leagueify-organization-1  |
leagueify-organization-1  | '||'      '||''''|      |      ..|'''.|  '||'  '|' '||''''|  '||' '||''''| '||' '|'
leagueify-organization-1  |  ||        ||  .       |||    .|'     '   ||    |   ||  .     ||   ||  .     || |
leagueify-organization-1  |  ||        ||''|      |  ||   ||    ....  ||    |   ||''|     ||   ||''|      ||
leagueify-organization-1  |  ||        ||        .''''|.  '|.    ||   ||    |   ||        ||   ||         ||
leagueify-organization-1  | .||.....| .||.....| .|.  .||.  ''|...'|    '|..'   .||.....| .||. .||.       .||.
leagueify-organization-1  |
leagueify-organization-1  |  ..|''||   '||''|.    ..|'''.|      |     '|.   '|' '||' |'''''||      |     |''||''| '||'  ..|''||   '|.   '|'
leagueify-organization-1  | .|'    ||   ||   ||  .|'     '     |||     |'|   |   ||      .|'      |||       ||     ||  .|'    ||   |'|   |
leagueify-organization-1  | ||      ||  ||''|'   ||    ....   |  ||    | '|. |   ||     ||       |  ||      ||     ||  ||      ||  | '|. |
leagueify-organization-1  | '|.     ||  ||   |.  '|.    ||   .''''|.   |   |||   ||   .|'       .''''|.     ||     ||  '|.     ||  |   |||
leagueify-organization-1  |  ''|...|'  .||.  '|'  ''|...'|  .|.  .||. .|.   '|  .||. ||......| .|.  .||.   .||.   .||.  ''|...|'  .|.   '|
leagueify-organization-1  |