Skip to content

Latest commit

 

History

History
44 lines (32 loc) · 2.07 KB

README.md

File metadata and controls

44 lines (32 loc) · 2.07 KB
Raw

Leagueify

Leagueify is an open source league management software that allows you to develop competitive and fun leagues for teams of all ages.

This server is written in Go using the Echo framework.

Getting Started

Using the provided development Docker compose example, Leagueify is quick and easy to get running with intuitive make commands.

# Start Leagueify in development mode
make start-dev

# Start Leagueify in detached development mode
make start-dev-detached

# Stop Leagueify and remove docker images
make clean-dev

After starting Leagueify with make start-dev you should see the Leagueify banner in the terminal, informing that the system is ready to be used. Upon saving changes, air will automatically reload the system, Leagueify will be ready once the banner is again shown.

leagueify-dev-1  | running...
leagueify-dev-1  |
leagueify-dev-1  | '||'      '||''''|      |      ..|'''.|  '||'  '|' '||''''|  '||' '||''''| '||' '|'
leagueify-dev-1  |  ||        ||  .       |||    .|'     '   ||    |   ||  .     ||   ||  .     || |
leagueify-dev-1  |  ||        ||''|      |  ||   ||    ....  ||    |   ||''|     ||   ||''|      ||
leagueify-dev-1  |  ||        ||        .''''|.  '|.    ||   ||    |   ||        ||   ||         ||
leagueify-dev-1  | .||.....| .||.....| .|.  .||.  ''|...'|    '|..'   .||.....| .||. .||.       .||.
leagueify-dev-1  | ⇨ http server started on [::]:8888

The Leagueify banner was generated using PatorJK.

Transparency Notice: Error & Performance Monitoring

To continuously improve the quality and performance of Leagueify, we utilize Sentry to monitor site errors and performance by default. This helps us identify and address any issues more efficiently. If you prefer to disable this monitoring, you can do so by setting the "SENTRY" to false in the environment variables.