diff --git a/README.md b/README.md index c69ba070..781af24d 100644 --- a/README.md +++ b/README.md @@ -18,7 +18,6 @@ Bracket is written in async Python (with [FastAPI](https://fastapi.tiangolo.com) ### Preview - # Quickstart To quickly run bracket to see how it works, clone it and run `docker-compose up`: diff --git a/docs/docusaurus.config.js b/docs/docusaurus.config.js index afbe2113..afd12eee 100644 --- a/docs/docusaurus.config.js +++ b/docs/docusaurus.config.js @@ -7,7 +7,7 @@ const darkCodeTheme = require('prism-react-renderer/themes/dracula'); /** @type {import('@docusaurus/types').Config} */ const config = { title: 'Bracket', - tagline: 'Tournament system', + tagline: 'Free and open source tournament scheduling system', favicon: 'img/logo.svg', // Set the production url of your site here @@ -18,8 +18,8 @@ const config = { // GitHub pages deployment config. // If you aren't using GitHub pages, you don't need these. - organizationName: 'facebook', // Usually your GitHub org/user name. - projectName: 'docusaurus', // Usually your repo name. + organizationName: 'evroon', // Usually your GitHub org/user name. + projectName: 'bracket', // Usually your repo name. onBrokenLinks: 'throw', onBrokenMarkdownLinks: 'warn', diff --git a/docs/src/components/HomepageFeatures/index.js b/docs/src/components/HomepageFeatures/index.js index 5fdd1f3d..8bf83c0a 100644 --- a/docs/src/components/HomepageFeatures/index.js +++ b/docs/src/components/HomepageFeatures/index.js @@ -4,36 +4,61 @@ import styles from './styles.module.css'; const FeatureList = [ { - title: 'Self-hosted', + title: 'Open-source and free', + Svg: require('@site/static/img/availability-svgrepo-com.svg').default, description: ( <> - Bracket is fully open source and you are free to host it yourself. + Bracket is fully open source and free to use, licensed under the MIT license. ), }, { title: 'Flexible', + Svg: require('@site/static/img/system-settings-svgrepo-com.svg').default, description: ( <> - Bracket supports multiple tournament types (ladder and swiss), teams can be added/changed - during the tournament and new matches can be scheduled while the last round has not yet - finished. + Bracket supports the standard tournament types, teams can be added/changed + during the tournament and new matches can be scheduled dynamically. ), }, { title: 'Easy to use', + Svg: require('@site/static/img/interface-control-svgrepo-com.svg').default, description: ( <> The UI is meant to be easy to use while providing maximum flexibility. ), }, + { + title: 'Selfhosted', + Svg: require('@site/static/img/host-record-svgrepo-com.svg').default, + description: ( + <> + You are free to host it yourself. Setup is easy; either run it in Docker or run it the + natively on the host. The only external dependency is a PostgreSQL database. + + ), + }, + { + title: 'Modern codebase', + Svg: require('@site/static/img/multiple-defenses-svgrepo-com.svg').default, + description: ( + <> + Bracket has a frontend build with Next.js and Mantine. The backend is written in async + Python using FastAPI. + + ), + } ]; function Feature({Svg, title, description}) { return (
+
+ +

{title}

{description}

@@ -46,7 +71,7 @@ export default function HomepageFeatures() { return (
-
+
{FeatureList.map((props, idx) => ( ))} diff --git a/docs/src/pages/index.js b/docs/src/pages/index.js index 01d17fea..2f437097 100644 --- a/docs/src/pages/index.js +++ b/docs/src/pages/index.js @@ -12,15 +12,22 @@ function HomepageHeader() { return (
-

{siteConfig.title}

-

{siteConfig.tagline}

-
- - Introduction - -
+
+

{siteConfig.title}

+

{siteConfig.tagline}

+
+ + Get Started + +
+
+
+
+ Preview of the web interface +
+
); diff --git a/docs/src/pages/index.module.css b/docs/src/pages/index.module.css index 9f71a5da..b4566b53 100644 --- a/docs/src/pages/index.module.css +++ b/docs/src/pages/index.module.css @@ -8,6 +8,7 @@ text-align: center; position: relative; overflow: hidden; + background-color: #3c4a67; } @media screen and (max-width: 996px) { diff --git a/docs/static/img/availability-svgrepo-com.svg b/docs/static/img/availability-svgrepo-com.svg new file mode 100644 index 00000000..85600e91 --- /dev/null +++ b/docs/static/img/availability-svgrepo-com.svg @@ -0,0 +1,3 @@ + + + \ No newline at end of file diff --git a/docs/static/img/host-record-svgrepo-com.svg b/docs/static/img/host-record-svgrepo-com.svg new file mode 100644 index 00000000..fd9bba54 --- /dev/null +++ b/docs/static/img/host-record-svgrepo-com.svg @@ -0,0 +1,3 @@ + + + \ No newline at end of file diff --git a/docs/static/img/interface-control-svgrepo-com.svg b/docs/static/img/interface-control-svgrepo-com.svg new file mode 100644 index 00000000..2bbf6d74 --- /dev/null +++ b/docs/static/img/interface-control-svgrepo-com.svg @@ -0,0 +1,3 @@ + + + \ No newline at end of file diff --git a/docs/static/img/multiple-defenses-svgrepo-com.svg b/docs/static/img/multiple-defenses-svgrepo-com.svg new file mode 100644 index 00000000..eb1f0fec --- /dev/null +++ b/docs/static/img/multiple-defenses-svgrepo-com.svg @@ -0,0 +1,3 @@ + + + \ No newline at end of file diff --git a/docs/static/img/schedule_preview.png b/docs/static/img/schedule_preview.png new file mode 100644 index 00000000..0c62b61a Binary files /dev/null and b/docs/static/img/schedule_preview.png differ diff --git a/docs/static/img/system-settings-svgrepo-com.svg b/docs/static/img/system-settings-svgrepo-com.svg new file mode 100644 index 00000000..9859f191 --- /dev/null +++ b/docs/static/img/system-settings-svgrepo-com.svg @@ -0,0 +1,3 @@ + + + \ No newline at end of file diff --git a/misc/img/schedule_preview.png b/misc/img/schedule_preview.png index 87f1b17d..0c62b61a 100644 Binary files a/misc/img/schedule_preview.png and b/misc/img/schedule_preview.png differ