Mono repository for the tourney project. This project is a web application for managing tournaments.
It includes an admin dashboard for managing tournaments, teams/players, live scores, and a client app for tournament attendees.
tourney follows the Semantic Versioning guidelines.
- clone the repository:
git clone https://github.com/Dino-Kupinic/tourney.git- Run the installation script and follow the instructions
./scripts/setup.shNote
Windows users need WSL installed.
Requirements:
- Docker
- Bun
- install packages
bun iTip
If you don't have bun installed, checkout https://bun.sh to install for your operating system.
- run supabase
bun run start:supabaseTip
If you don't have docker installed, checkout https://www.docker.com/.
- head to http://127.0.0.1:54323
If it works, great!
- define environment variables
Create a .env file and checkout the .env.example.
Copy the content into your .env and replace the following fields with your own.
| Field | Description |
|---|---|
SUPABASE_URL |
URL to Supabase API |
SUPABASE_KEY |
Anon key |
SUPABASE_SERVICE_KEY |
Service Role Key |
NUXT_PUBLIC_CLIENT_URL |
URL of the viewer app, default http://localhost:3001 |
- run dev server
bun run dev:admin- Head to http://localhost:3000/
If it works, great!
- define environment variables
Create a .env file and checkout the .env.example. Copy the content into your .env and replace the following fields
| Field | Description |
|---|---|
SUPABASE_URL |
URL to Supabase API |
SUPABASE_KEY |
Anon key |
- run dev server
bun run dev:viewer- Head to http://localhost:3001/
If it works, great!
- define environment variables
Create a .env file and checkout the .env.example. Copy the content into your .env and replace the following fields
| Field | Description |
|---|---|
SUPABASE_URL |
URL to Supabase API |
SUPABASE_KEY |
Anon key |
USERS_TO_CREATE |
See comment in .env.example |
- run the script
bun run create:usersIf it works, great! You can now log in in the admin dashboard with the created users.
- build the app
bun run buildCaution
The following section will be deprecated in the future!
- start the app
bun run app:startTip
Didn't work?
Try installing pm2 globally with npm install pm2 -g.
For npm you need to install Node.js.
- monitor the app
bun run app:monitor- enjoy the app!
- Nuxt 3
- Supabase
- Docker
- pm2
Contributions are always welcome! Feel free to create an issue or submit a pull request. Please follow coding standards and commit message conventions.