📦 Contents

Description
Usage
Characteristics
Installation
Sources
Licenses

ℹ️ Description

Commentary Tool is a website where commentators can commentate on 🥏 matches with a real-time statsboard. Statistics keepers can add/edit stats during a match via a page that is specifcally designed to give the ability to do it as fast as possible. Users in general can sign-up and they can create/edit their player or team profile.

🖥️ Usage

This website is used by the commentators of Ulti.TV. They can add & edit tournaments, matches, teams & players.

✨ Characteristics

This project is build in Sveltekit. Sveltekit is configured with Vanilla JavaScript & CSS. There is no type checking enabled. Authentication & data is stored in Supabase and is fetched with the REST API and there will be an option to fetch it with GraphQL in the future.

📥 Installation

Do you want to start this project locally? Then follow the next steps. NB! NodeJS must be installed to run npm commands. In the resources section there is a link to the NodeJS website

Open your terminal. Make sure you are in the path of the project.
```
path_to_the_project/lets-jam-webapplicatie %
```
Before you can start the application you must install all modules.
```
npm install
```
When the installation is complete you can start the application with the following command.
```
npm run dev
```

Or when you want to open the browser directly with the correct URL.

npm run dev --open

4. Make sure to fill in .env with the required database keys & url.
```env
PUBLIC_SUPABASE_URL="https://put_unique_url_here.supabase.co"
PUBLIC_SUPABASE_ANON_KEY="put_anon_key_here"

🌍 Sources

🪪 Licenses

This project is licensed under the terms of the MIT license.

Sascha-davidson / lets-jam-webapplicatie

readme