Appex Tournaments

Website for managing tournaments
Explore the docs »

Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
   • How to
4. Roadmap
5. Acknowledgments

About The Project

Project was started with the task to create a system for internal use to create tournaments with a bracket system.
We used the project to practice our NuxtJS skills and to try out Nuxt 3 (which was barely released at the time back then)

The Quest (Oppgaven)

1. Should work somewhat like [Challonge](https://challonge.com/)
2. Use Nuxt 3

3. Partial Tasks

   • Clarify roles in the project

     • Project leader (gives statusupdate every wednesday)
     • Designer
     • Backend-dev
     • Frontend-dev

   • Make a plan for which pages are needed. F.eks:

     • Register tournament
     • Tournament player setup preview
     • Tournament page for registering match scores
     • Page where next page is displayed
     • More?
4. Make a sketch in Figma. Should follow Appex's color scheme.
5. Find out how you wish to store data
6. Find out what technology you want to use for backend
7. Can we use already existing open-source code to make it easier? F.eks Vue bracket component
8. Begin with a proof-of-concept
9. Make a good data model for backend (required objects and fields)
10. CRUD logic for data model and setup API endpoints in backend for this.
11. Make frontend pages and components for the required pages
12. Send necessary data between frontend and backend
13. Test and ajust
14. Invite to the first test tournament "Appex Billiards 2022" :D

Built With

Frontend was written in Nuxt, with Tailwind, C# .NET for backend and MongoDB for database.

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

To run this project you'll need to have nodejs installed on your computer. You can download it here

Get latest npm version

• npm

  npm install npm@latest -g

• yarn

  npm install -g yarn

Installation

1. Clone the repo

   git clone https://github.com/ArvidWedtstein/Appex-Tournaments.git

2. Install NPM packages

   npm install

3. Create a .env file in the both frontend and backend directory and add your environment variables.

4. Setup SEQ for backend logging.

5. Setup some more stuff which i can't remember.

Deploying

We hosted the frontend part on netlify, and backend on google cloud. Both are no longer up and running.

Usage

Can be used to create tournaments :)

How to

1. To create a new tournament, hit "Opprett turnering"

!Name cannot be longer than 69 characters.

Press on arrow when you have filld the input fields

2. Adjust the amount of players with [+] and [-] symbols

Click so on Ny Turnering

3. You will now get a setup of the tournament.

Click on Begynn turnering to start tournament immediately. You can also click on Utsett turnering to play the tournament later.

If your pressed Begynn turnering you should get a view of the tournament.

4. To choose a winner for a match, you simple click on the winners name.

NB Next round's matches will first be generated when the first one is completed.

Previous Tournaments

To see your past tournaments, click on Se tidligere turneringer.

Each tournament shows the amount of players and the current status of the tournament.

How do i edit a tournament?

1. To edit a tournament you have to click on Se tidligere turneringer.

2. Click so on the tournament you want to edit

You'll get a menu where you can edit name, players and date.

3. Press save Lagre to save the changes.

You can also press delete Slett to let the tournament magically disappear.

Roadmap

Nothing planned for this project in the future

See the open issues for a full list of proposed features (and known issues).

(back to top)

Acknowledgments

Thanks to Victor, Harald, David and Appex for teaching us Nuxt and C#.