GNU Affero General Public License v3.0

项目介绍

evroon/bracket 是一个托管在 GitHub 上的开源项目,主要使用 TypeScript 编写,采用 GNU Affero General Public License v3.0 许可证,目前获得 1.8k 个 Star、178 次 Fork。

仓库全名
evroon/bracket
开源许可证
GNU Affero General Public License v3.0
Star 数
1.8k
Fork 数
178
未关闭 Issue
49

README 摘要

width="500" src="frontend/public/favicon-wide.svg" alt="Bracket - Tournament System" /> Demo · Documentation · Quickstart · GitHub · Releases Tournament system meant to be easy to use. Bracket is written in async Python (with FastAPI) and Vite as frontend using the Mantine library. It has the following features: Supports single elimination, round-robin and swiss formats. Build your tournament structure with multiple…

完整内容见 GitHub 原始 README 或本页 。

常见问题

bracket 用什么语言开发?

主要使用 TypeScript 编写,采用 GNU Affero General Public License v3.0 许可证,目前有 1.8k 个 Star。

bracket 可以免费商用吗?

仓库标注的许可证为 GNU Affero General Public License v3.0,商用前请先阅读仓库 LICENSE 文件确认授权范围。

如何获取 bracket 的源码?

可以直接克隆仓库:git clone https://github.com/evroon/bracket.git,默认分支为 master;安装与运行步骤见仓库 README。

bracket 最近还在维护吗?

仓库最近一次更新为 1 周前,当前有 49 个未关闭 Issue;Star 数为 1.8k,可作为社区活跃度的参考。

语言占比

CSS
Dockerfile
HTML
JavaScript
Mako
Python
Shell
TypeScript

Release

README

Bracket - Tournament System

build status translations last commit release codecov

Demo · Documentation · Quickstart · GitHub · Releases

evroon/bracket | Trendshift

Tournament system meant to be easy to use. Bracket is written in async Python (with FastAPI) and Vite as frontend using the Mantine library.

It has the following features:

  • Supports single elimination, round-robin and swiss formats.
  • Build your tournament structure with multiple stages that can have multiple groups/brackets in them.
  • Drag-and-drop matches to different courts or reschedule them to another start time.
  • Various dashboard pages are available that can be presented to the public, customized with a logo.
  • Create/update teams, and add players to teams.
  • Create multiple clubs, with multiple tournaments per club.
  • Swiss tournaments can be handled dynamically, with automatic scheduling of matches.

Explore the Bracket docs  ▶

Live Demo

A demo is available for free at https://www.bracketapp.nl/demo. The demo lasts for 30 minutes, after which your data will de deleted.

Quickstart

To quickly run bracket to see how it works, clone it and run docker compose up:

git clone [email protected]:evroon/bracket.git
cd bracket
sudo docker compose up -d

This will start the backend and frontend of Bracket, as well as a postgres instance. You should now be able to view bracket at http://localhost:3000. You can log in with the following credentials:

To insert dummy rows into the database, run:

docker exec bracket-backend uv run --no-dev ./cli.py create-dev-db

See also the quickstart docs.

Usage

Read the usage guide for how to organize a tournament in Bracket from start to finish.

Configuration

Read the configuration docs for how to configure Bracket.

Bracket’s backend is configured using .env files (prod.env for production, dev.env for development etc.). But you can also configure Bracket using environment variables directly, for example by specifying them in the docker-compose.yml.

The frontend doesn’t can be configured by environment variables as well, as well as .env files using Vite’s way of loading environment variables.

Running Bracket in production

Read the deployment docs for how to deploy Bracket and run it in production.

Bracket can be run in Docker or by itself (using uv and pnpm).

Development setup

Read the development docs for how to run Bracket for development.

Prerequisites are pnpm, postgresql and uv to run the frontend, database and backend.

Translations

Based on your browser settings, your language should be automatically detected and loaded. For now, there’s no manual way of choosing a different language.

Supported Languages

To add/refine translations, Crowdin is used. See the docs for more information.

More screenshots

Help

If you’re having trouble getting Bracket up and running, or have a question about usage or configuration, feel free to ask. The best place to do this is by creating a Discussion.

Supporting Bracket

If you’re using Bracket and would like to help support its development, that would be greatly appreciated!

Several areas that we need a bit of help with at the moment are:

  • ⭐ Star Bracket on GitHub
  • 🌐 Translating: Help make Bracket available to non-native English speakers by adding your language (via crowdin)
  • 📣 Spread the word by sharing Bracket to help new users discover it
  • 🖥️ Submit a PR to add a new feature, fix a bug, extend/update the docs or something else

See the contribution docs for more information on how to contribute

Contributors

evroon
Erik Vroon
robigan
Null
BachErik
BachErik
ByteAfterlife
Byte
djpiper28
Danny Piper
MaxRickettsUy
Max Ricketts-Uy
sevi418
Sevi C
nvanheuverzwijn
Nicolas Vanheuverzwijn
aminnairi
Amin NAIRI
FelipeGdM
Felipe Gomes De Melo
IzStriker
IzStriker
jmillxyz
Jon Miller
babeuh
Raphael Le Goaller

License

Bracket is licensed under AGPL-v3.0.

Please note that any contributions also fall under this license.

See LICENSE

评论

暂无评论