Skip to content

Latest commit

 

History

History
42 lines (27 loc) · 1.1 KB

README.md

File metadata and controls

42 lines (27 loc) · 1.1 KB
Raw

Leagueify API

Leagueify is an open source platform for managing sporting leagues of any size.

This server is written in Go using the Echo framework.

Getting Started

By default the API documentation can be found at http://localhost/api

Leagueify API uses easy to use Makefile commands to get up and running quickly. Currently, Leagueify API requires Go 1.22.0 in order to run, please install Go before proceeding with the following commands:

# Install Dependencies
make init

# Run Leagueify Locally
make dev-start

# Stop Leagueify and Remove Docker Image
make dev-clean

NOTE: Until the email configuration has been developed, it would be best to add "id": account.ID, to internal/api/accounts:96

Contribution Requirements

Leagueify API makes use of automated checks to verify code quality. To ensure code quality, please run the following commands before creating a PR:

# Vet Code for Errors
make vet

# Format Code 
make format

# Clean Go Dependencies
make clean