https://github.com/david-torres/tournament-organizer
A REST API for creating and managing tournaments (single-elimination or round-robin), participants, and matches, with support for ELO ratings and bracket visualization.
https://github.com/david-torres/tournament-organizer
javascript tournament tournament-manager
Last synced: 5 months ago
JSON representation
A REST API for creating and managing tournaments (single-elimination or round-robin), participants, and matches, with support for ELO ratings and bracket visualization.
- Host: GitHub
- URL: https://github.com/david-torres/tournament-organizer
- Owner: david-torres
- License: mit
- Created: 2023-04-08T03:11:03.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2025-01-08T00:01:49.000Z (5 months ago)
- Last Synced: 2025-01-08T01:17:32.184Z (5 months ago)
- Topics: javascript, tournament, tournament-manager
- Language: JavaScript
- Homepage:
- Size: 116 KB
- Stars: 4
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Tournament Organizer API
A REST API for creating and managing tournaments, participants, and matches, with support for Elo ratings and bracket visualization.
## Tournament Types Supported
- Single-elimination
- Round robin
- Swiss
- League
## Features
- Generate randomized matches, supporting byes for the highest ranked players
- Track member Elo scores across matches and tournaments
- Leagues for regularly starting with a fresh Elo score and configurable Elo decay after a period of non-participation
- Generate a bracket graphic for visualizing the tournament
## Getting Started
### Prerequisites
- Node.js (v14 or newer)
- npm (v6 or newer)
### Installation
1. Clone the repository:
git clone https://github.com/david-torres/tournament-organizer.git
cd tournament-organizer
2. Install dependencies:
npm install
3. Start the API server:
node app.js
The API server will be running at `http://localhost:3000`.
## API Endpoints
| Method | Endpoint | Description |
|--------|----------------------------------------|----------------------------------------------------|
| GET | /members | Get a list of members |
| GET | /members/search?name=NAME | Search for a member by name |
| POST | /members | Create a new member |
| POST | /tournaments | Create a new tournament |
| GET | /tournaments/latest | Get the most current active tournament |
| GET | /tournaments/:id/participants | Get a list of tournament participants |
| POST | /tournaments/:id/participants | Add a member to a tournament |
| POST | /tournaments/:id/start | Generate matches to start a tournament |
| GET | /tournaments/:id/matches | Get the list of matches for a tournament |
| PATCH | /tournaments/:id/matches/:id | Update a match (set the winner) |
| GET | /tournaments/:id/bracket | Get the bracket data for a tournament |
| POST | /tournaments/:id/league | End a league tournament |
| POST | /tournaments/:id/decay-elo | Decay Elo scores for a league |
## Bracket Visualization
You can get an HTML or PNG representation of the tournament bracket by calling:
HTML
wget http://localhost:3000/tournaments/:id/bracket?format=html
PNG
wget http://localhost:3000/tournaments/:id/bracket?format=image
## Running the Simulation Script
You can run the `simulate-tournament.js` script to simulate the entire flow of adding members, creating a tournament, participants joining, generating matches, and randomly assigning winners until the tournament is complete. Helpers have been added to package.json and can be run using npm:
Single Elimination:
npm run sim-single-elim
Round Robin:
npm run sim-round-robin
Swiss:
npm run sim-swiss
League:
npm run sim-league
## AI Disclosure
A large amount of this code was generated by ChatGPT (GPT-4). That said, it was pretty buggy and broken and I had to fix it up a fair amount to get it usable. See the [prompt](gpt-prompt.txt).
## License
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.