Kessinen/levyraatiRevived.old
Archived
1
0
Fork 0
Code Issues 5 Pull Requests Projects 1 Wiki Activity

Change Translate README.md

Browse Source
This commit is contained in:
Esa Kataja
2024-10-12 10:13:34 +03:00
parent 0a2dc6a745
commit 6b5f051349
1 changed files with 30 additions and 30 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+30 -30
View File
@@ -1,59 +1,59 @@
# Levyraati Revived # Levyraati Revived
## Yleiskatsaus ## Overview
**Levyraati Revived** on SvelteKitillä rakennettu web-sovellus, joka tarjoaa hauskan ja vuorovaikutteisen alustan, jossa panelistit voivat arvioida ja pisteyttää musiikkikappaleita. Panelistit voivat lähettää kappaleita joko YouTube-linkkeinä tai äänitiedostoina (MP3, OGG jne.). Sovelluksessa kappaleet kuunnellaan kierroksittain, pisteytetään, ja voittaja julistetaan yhteispisteiden perusteella. **Levyraati Revived** is a web application built with SvelteKit, designed to offer a fun, interactive platform for a group of panelists to review and rate songs. Panelists can submit songs via YouTube links or by uploading audio files (MP3, OGG, etc.). The app supports events where songs are listened to in rounds, rated by the panelists, and a winner is announced based on total points scored.
> ⚠️ Huomio: Tämä projekti on kehityksen alkuvaiheessa. Ominaisuudet ja toiminnallisuudet saattavat muuttua parannusten myötä. Palaute on aina tervetullutta! > ⚠️ Note: This project is still in the early stages of development. Features and functionality may change as we continue to improve. Feedback is always welcome!
## Ominaisuudet ## Features
- **Tapahtumien luominen**: Käyttäjä voi luoda tapahtuman ja kutsua muita osallistujia. - **Create Events**: A user can create an event and invite others to join.
- **Kappaleiden lähetys**: Panelistit voivat lähettää kappaleita joko YouTube-linkkeinä tai lataamalla äänitiedostoja. - **Song Submission**: Panelists can submit songs either by providing a YouTube link or by uploading audio files.
- **Pisteytysjärjestelmä**: Jokainen panelisti pisteyttää kappaleet asteikolla 1–10. - **Rating System**: Each panelist rates the songs on a scale from 1 to 10.
- **Kierrospohjainen kuuntelu**: Kappaleet soitetaan kierroksittain, ja jokainen kappale pisteytetään kuuntelun jälkeen. - **Round-Based Listening**: The songs are played in rounds, and ratings are collected for each song.
- **Voittajan julistus**: Sovellus laskee pisteet ja julistaa automaattisesti voittajan. - **Winner Announcement**: The app automatically calculates and announces the song with the highest score as the winner.
## Käyttöohjeet ## Usage
1. **Tapahtuman luominen**: Käyttäjä voi luoda uuden tapahtuman ja kutsua panelistit sähköpostitse. 1. **Create an Event: A user can create a new event and invite panelists via email.**
2. **Tapahtumaan liittyminen**: Kutsutut panelistit voivat liittyä tapahtumaan saamansa kutsulinkin avulla. 2. **Join an Event: Invited panelists can join the event using the invitation link sent to their email.**
3. **Kappaleiden lähetys**: Jokainen panelisti lähettää kappaleensa arvioitavaksi ennen tapahtuman alkua. 3. **Submit Songs: Each panelist submits a song for review before the event date.**
4. **Kappaleiden pisteytys**: Tapahtuman aikana kappaleet kuunnellaan yksi kerrallaan, ja panelistit antavat pisteet. 4. **Rate Songs: During the event, songs are played one by one, and panelists provide their ratings.**
5. **Tulosten katselu**: Kun kaikki kappaleet on pisteytetty, sovellus laskee kokonaispisteet ja julistaa voittajan. 5. **View Results: After all songs have been rated, the app calculates the total scores and announces the winner.**
## Käytetyt teknologiat ## Technologies Used
- **SvelteKit**: Käyttöliittymän rakentamiseen ja reititysten hallintaan. - **SvelteKit:** For building the app’s user interface and handling routing.
- **Supabase**: Backend-as-a-Service-ratkaisu, joka tarjoaa autentikoinnin ja tietokannan hallinnan. - **Supabase:** Backend-as-a-Service for storing and managing data.
- **Tailwind CSS**: Tyylittelyyn ja responsiiviseen suunnitteluun. - **Tailwind CSS:** For styling and responsive design.
- **JavaScript / TypeScript**: Sovelluksen ohjelmointiin ja toiminnallisuuteen. - **YouTube API:** (optional) for handling YouTube links if needed.
- **Vite**: Nopea kehitysympäristö ja hot module replacement. - **MusicBrainz API:** (optional) for fetching song information if needed.
- **YouTube API**: (valinnainen) YouTube-linkkien käsittelyyn tarvittaessa. - **lyrics.ovh:** (optional) for fetching lyrics if needed.
## Lisenssi ## License
Tämä projekti on lisensoitu MIT-lisenssillä. Katso lisätiedot LICENSE-tiedostosta. This project is licensed under the MIT License - see the LICENSE file for details.
## Asennus & käyttöönotto ## Installation & Setup
1. **Kloonaa repository:** 1. **Clone the repository:**
```bash ```bash
git clone https://git.kessinen.com:3000/Kessinen/levyraati2024-frontend.git git clone https://git.kessinen.com:3000/Kessinen/levyraati2024-frontend.git
cd levyraati-2024 cd levyraati-2024
``` ```
2. **Asenna riippuvuudet:** 2. **Install dependencies:**
```bash ```bash
npm install npm install
``` ```
3. **Käynnistä kehityspalvelin:** 3. **Start the development server:**
```bash ```bash
npm run dev npm run dev
``` ```
4. **Rakennus tuotantoa varten:** 4. **Build for production:**
```bash ```bash
npm run build npm run build
``` ```
5. **Esikatsele tuotantoversio:** 5. **Preview production build:**
```bash ```bash
npm run preview npm run preview
``` ```