mirror/bracket
1
0
Fork 0
mirror of https://github.com/evroon/bracket.git synced 2026-01-18 11:08:49 -05:00
Code Issues Packages Projects Releases Wiki Activity

Improve readme header (#555)

Browse Source
This commit is contained in:
Erik Vroon
2024-02-27 20:22:18 +01:00
committed by GitHub
parent 07b39e02c7
commit eb13f7eda4
2 changed files with 182 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files

61
README.md
View File

@@ -1,19 +1,45 @@
<img align="left" alt="Favicon of Bracket" src="frontend/public/favicon.svg" height="150" />
<p align="center">
<img
width="500"
src="frontend/public/favicon-wide.svg"
alt="Bracket - Tournament System"
/>
</p>
# Bracket
[![codecov](https://codecov.io/gh/evroon/bracket/branch/master/graph/badge.svg?token=YJL0DVPFFG)](https://codecov.io/gh/evroon/bracket)
[![backend](https://github.com/evroon/bracket/actions/workflows/backend.yml/badge.svg)](https://github.com/evroon/bracket/actions/workflows/backend.yml)
[![frontend](https://github.com/evroon/bracket/actions/workflows/frontend.yml/badge.svg)](https://github.com/evroon/bracket/actions/workflows/frontend.yml)
[![last
commit](https://img.shields.io/github/last-commit/evroon/bracket)](https://img.shields.io/github/last-commit/evroon/bracket)
[![release](https://img.shields.io/github/v/release/evroon/bracket)](https://img.shields.io/github/v/release/evroon/bracket)<br/>
[Demo](https://www.bracketapp.nl/demo) |
[Documentation](https://docs.bracketapp.nl) |
[Quickstart](https://docs.bracketapp.nl/docs/running-bracket/quickstart) |
[GitHub](https://github.com/evroon/bracket) |
[Releases](https://github.com/evroon/bracket/releases)
<br/>
<p align="center">
<a href="https://github.com/evroon/bracket/actions"
><img
src="https://img.shields.io/github/actions/workflow/status/evroon/bracket/backend.yml"
alt="build status"
/></a>
<a href="https://github.com/evroon/bracket/commits/"
><img
src="https://img.shields.io/github/last-commit/evroon/bracket"
alt="last commit"
/></a>
<a href="https://github.com/evroon/bracket/releases"
><img
src="https://img.shields.io/github/v/release/evroon/bracket"
alt="release"
/></a>
<a href="https://codecov.io/gh/evroon/bracket"
><img
src="https://codecov.io/gh/evroon/bracket/branch/master/graph/badge.svg?token=YJL0DVPFFG"
alt="codecov"
/></a>
</p>
<p align="center">
<a href="https://www.bracketapp.nl/demo">Demo</a>
·
<a href="https://docs.bracketapp.nl">Documentation</a>
·
<a href="https://docs.bracketapp.nl/docs/running-bracket/quickstart">Quickstart</a>
·
<a href="https://github.com/evroon/bracket">GitHub</a>
·
<a href="https://github.com/evroon/bracket/releases">Releases</a>
</p>
<h1></h1>
Tournament system meant to be easy to use. Bracket is written in async Python (with
[FastAPI](https://fastapi.tiangolo.com)) and [Next.js](https://nextjs.org/) as frontend using the
@@ -30,9 +56,12 @@ It has the following features:
- Create **multiple clubs**, with **multiple tournaments** per club.
- **Swiss tournaments** can be handled dynamically, with automatic scheduling of matches.
### Preview
<img alt="" src="docs/static/img/bracket-screenshot-design.png" width="100%" />
<p align="center">
<a href="https://docs.bracketapp.nl"><strong>Explore the Bracket docs&nbsp;&nbsp;▶</strong></a>
</p>
# 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.

137
frontend/public/favicon-wide.svg Normal file
View File

@@ -0,0 +1,137 @@
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!-- Created with Inkscape (http://www.inkscape.org/) -->
<svg
width="65.672195mm"
height="27.21875mm"
viewBox="0 0 65.672195 27.21875"
version="1.1"
id="svg5"
inkscape:export-filename="/home/erik/code/bracket/frontend/public/favicon.png"
inkscape:export-xdpi="400.06485"
inkscape:export-ydpi="400.06485"
sodipodi:docname="favicon-wide.svg"
inkscape:version="1.1.2 (0a00cf5339, 2022-02-04)"
xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape"
xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd"
xmlns:xlink="http://www.w3.org/1999/xlink"
xmlns="http://www.w3.org/2000/svg"
xmlns:svg="http://www.w3.org/2000/svg">
<sodipodi:namedview
id="namedview7"
pagecolor="#ffffff"
bordercolor="#666666"
borderopacity="1.0"
inkscape:pageshadow="2"
inkscape:pageopacity="0.0"
inkscape:pagecheckerboard="0"
inkscape:document-units="mm"
showgrid="false"
inkscape:zoom="4.5634325"
inkscape:cx="62.124288"
inkscape:cy="57.084223"
inkscape:window-width="3840"
inkscape:window-height="2096"
inkscape:window-x="0"
inkscape:window-y="27"
inkscape:window-maximized="1"
inkscape:current-layer="g21836"
fit-margin-top="0"
fit-margin-left="0"
fit-margin-right="0"
fit-margin-bottom="0"
showguides="true"
inkscape:guide-bbox="true" />
<defs
id="defs2">
<linearGradient
inkscape:collect="always"
id="linearGradient37147">
<stop
style="stop-color:#6948e8;stop-opacity:1"
offset="0"
id="stop37143" />
<stop
style="stop-color:#9379f5;stop-opacity:1"
offset="1"
id="stop37145" />
</linearGradient>
<linearGradient
inkscape:collect="always"
xlink:href="#linearGradient37147"
id="linearGradient37149-5"
x1="197.95337"
y1="200.584"
x2="42.395298"
y2="31.763771"
gradientUnits="userSpaceOnUse"
gradientTransform="matrix(0.31598688,0,0,0.31598688,28.637086,74.676847)" />
</defs>
<g
inkscape:label="Layer 1"
inkscape:groupmode="layer"
id="layer1"
transform="translate(-70.13097,-126.01448)">
<g
id="g21630"
transform="translate(4.3159573)">
<g
id="g21643"
transform="translate(1.0671615)">
<g
id="g21836"
transform="translate(1.368642)">
<text
xml:space="preserve"
style="font-style:normal;font-weight:normal;font-size:10.5833px;line-height:1.25;font-family:sans-serif;fill:#7957f5;fill-opacity:1;stroke:none;stroke-width:0.265;stroke-miterlimit:4;stroke-dasharray:none"
x="92.581429"
y="143.52644"
id="text1989"><tspan
sodipodi:role="line"
id="tspan1987"
style="font-style:normal;font-variant:normal;font-weight:800;font-stretch:normal;font-size:10.5833px;font-family:Lato;-inkscape-font-specification:'Lato, Ultra-Bold';font-variant-ligatures:normal;font-variant-caps:normal;font-variant-numeric:normal;font-variant-east-asian:normal;fill:#7957f5;fill-opacity:1;stroke-width:0.265;stroke-miterlimit:4;stroke-dasharray:none"
x="92.581429"
y="143.52644">Bracket</tspan></text>
<g
id="g21743"
transform="matrix(0.36930899,0,0,0.36930899,52.803278,98.435645)">
<path
id="path33666-9"
style="fill:url(#linearGradient37149-5);fill-opacity:1;fill-rule:evenodd;stroke-width:0.315986"
d="M 65.487787,74.676857 A 36.850776,36.850776 0 0 0 28.63708,111.52764 36.850776,36.850776 0 0 0 60.434534,148.01609 l -13.091302,-13.09121 0.639774,-19.35673 -1.781779,7.8368 -9.307407,-9.30749 3.464113,-2.45816 7.625073,3.92885 -2.9291,-5.22051 6.111755,-18.921003 9.453135,-5.4637 25.546141,25.546143 -2.52109,-23.285493 18.343283,18.343283 A 36.850776,36.850776 0 0 0 65.488137,74.676857 Z" />
<path
id="path33606-9"
style="fill:#5337b9;fill-opacity:1;fill-rule:evenodd;stroke-width:0.315986"
d="m 101.98679,106.56687 -18.343293,-18.343283 2.52109,23.285493 -25.54614,-25.546143 -9.453134,5.4637 -6.111756,18.921003 2.9291,5.22051 -0.639774,19.35673 13.091302,13.09121 a 36.850776,36.850776 0 0 0 5.053252,0.3626 36.850776,36.850776 0 0 0 36.850793,-36.8507 36.850776,36.850776 0 0 0 -0.35214,-4.96077 z" />
<path
id="path53-0"
style="fill:#4629ae;fill-opacity:1;fill-rule:evenodd;stroke-width:0.315986"
d="m 40.357584,111.6393 -3.464112,2.45816 9.307407,9.30749 1.781778,-7.8368 z" />
<path
id="path33645-7"
style="fill:#7755f5;fill-opacity:1;fill-rule:evenodd;stroke-width:0.315986"
d="m 75.410557,89.433227 -5.05334,1.66942 8.04345,8.04407 1.59908,-5.46492 z" />
<path
id="path33668-6"
style="fill:#4629ae;fill-opacity:1;fill-rule:evenodd;stroke-width:0.315986"
d="m 75.410557,89.433227 4.58919,4.24857 -1.59908,5.46492 -8.04345,-8.04407 z" />
<g
aria-label="{}"
id="text1281-3"
style="font-size:46.3909px;line-height:1.25;font-family:monospace;-inkscape-font-specification:monospace;fill:#ffffff;stroke-width:1.15977"
transform="matrix(1.1942812,0,0,1.1942812,-57.483829,-55.222461)">
<path
d="m 98.88979,156.70333 v 4.3265 h -3.397771 q -5.6403,0 -7.565704,-1.67623 -1.902751,-1.67624 -1.902751,-6.68229 v -4.87014 q 0,-3.42042 -1.223198,-4.71157 -1.200546,-1.31381 -4.371799,-1.31381 h -1.404412 v -4.32649 h 1.404412 q 3.171253,0 4.371799,-1.29115 1.223198,-1.29116 1.223198,-4.73423 v -4.87014 q 0,-5.00605 1.902751,-6.65963 1.925404,-1.67623 7.565704,-1.67623 h 3.397771 v 4.30384 h -2.786173 q -2.355787,0 -3.148601,0.95137 -0.792813,0.95138 -0.792813,4.19059 v 4.73423 q 0,3.73754 -1.109938,5.25522 -1.109939,1.51767 -3.964067,1.94805 2.854128,0.47569 3.964067,2.01601 1.109938,1.54032 1.109938,5.25522 v 4.64362 q 0,3.26186 0.792813,4.21324 0.792814,0.97402 3.148601,0.97402 z"
style="font-weight:bold;-inkscape-font-specification:'monospace, Bold'"
id="path33435-7" />
<path
d="m 107.04444,156.70333 h 2.74087 q 2.35579,0 3.17125,-0.97402 0.81547,-0.97403 0.81547,-4.21324 v -4.64362 q 0,-3.7149 1.10994,-5.25522 1.10993,-1.54032 3.94141,-2.01601 -2.85413,-0.43038 -3.96407,-1.94805 -1.08728,-1.51768 -1.08728,-5.25522 v -4.73423 q 0,-3.19391 -0.81547,-4.16793 -0.79281,-0.97403 -3.17125,-0.97403 h -2.74087 v -4.30384 h 3.39777 q 5.61765,0 7.49775,1.67623 1.90275,1.65358 1.90275,6.65963 v 4.87014 q 0,3.42042 1.2232,4.73423 1.24585,1.29115 4.43975,1.29115 h 1.40441 v 4.32649 h -1.40441 q -3.1939,0 -4.43975,1.31381 -1.2232,1.3138 -1.2232,4.71157 v 4.87014 q 0,5.00605 -1.90275,6.68229 -1.8801,1.67623 -7.49775,1.67623 h -3.39777 z"
style="font-weight:bold;-inkscape-font-specification:'monospace, Bold'"
id="path33437-6" />
</g>
</g>
</g>
</g>
</g>
</g>
</svg>
Side by Side

After

Width:  |  Height:  |  Size: 7.2 KiB