diff --git a/README.md b/README.md index eddab41..44f04da 100644 --- a/README.md +++ b/README.md @@ -1,59 +1,59 @@ # 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. -- **Kappaleiden lähetys**: Panelistit voivat lähettää kappaleita joko YouTube-linkkeinä tai lataamalla äänitiedostoja. -- **Pisteytysjärjestelmä**: Jokainen panelisti pisteyttää kappaleet asteikolla 1–10. -- **Kierrospohjainen kuuntelu**: Kappaleet soitetaan kierroksittain, ja jokainen kappale pisteytetään kuuntelun jälkeen. -- **Voittajan julistus**: Sovellus laskee pisteet ja julistaa automaattisesti voittajan. +- **Create Events**: A user can create an event and invite others to join. +- **Song Submission**: Panelists can submit songs either by providing a YouTube link or by uploading audio files. +- **Rating System**: Each panelist rates the songs on a scale from 1 to 10. +- **Round-Based Listening**: The songs are played in rounds, and ratings are collected for each song. +- **Winner Announcement**: The app automatically calculates and announces the song with the highest score as the winner. -## Käyttöohjeet -1. **Tapahtuman luominen**: Käyttäjä voi luoda uuden tapahtuman ja kutsua panelistit sähköpostitse. -2. **Tapahtumaan liittyminen**: Kutsutut panelistit voivat liittyä tapahtumaan saamansa kutsulinkin avulla. -3. **Kappaleiden lähetys**: Jokainen panelisti lähettää kappaleensa arvioitavaksi ennen tapahtuman alkua. -4. **Kappaleiden pisteytys**: Tapahtuman aikana kappaleet kuunnellaan yksi kerrallaan, ja panelistit antavat pisteet. -5. **Tulosten katselu**: Kun kaikki kappaleet on pisteytetty, sovellus laskee kokonaispisteet ja julistaa voittajan. +## Usage +1. **Create an Event: A user can create a new event and invite panelists via email.** +2. **Join an Event: Invited panelists can join the event using the invitation link sent to their email.** +3. **Submit Songs: Each panelist submits a song for review before the event date.** +4. **Rate Songs: During the event, songs are played one by one, and panelists provide their ratings.** +5. **View Results: After all songs have been rated, the app calculates the total scores and announces the winner.** -## Käytetyt teknologiat -- **SvelteKit**: Käyttöliittymän rakentamiseen ja reititysten hallintaan. -- **Supabase**: Backend-as-a-Service-ratkaisu, joka tarjoaa autentikoinnin ja tietokannan hallinnan. -- **Tailwind CSS**: Tyylittelyyn ja responsiiviseen suunnitteluun. -- **JavaScript / TypeScript**: Sovelluksen ohjelmointiin ja toiminnallisuuteen. -- **Vite**: Nopea kehitysympäristö ja hot module replacement. -- **YouTube API**: (valinnainen) YouTube-linkkien käsittelyyn tarvittaessa. +## Technologies Used +- **SvelteKit:** For building the app’s user interface and handling routing. +- **Supabase:** Backend-as-a-Service for storing and managing data. +- **Tailwind CSS:** For styling and responsive design. +- **YouTube API:** (optional) for handling YouTube links if needed. +- **MusicBrainz API:** (optional) for fetching song information if needed. +- **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 git clone https://git.kessinen.com:3000/Kessinen/levyraati2024-frontend.git cd levyraati-2024 ``` -2. **Asenna riippuvuudet:** +2. **Install dependencies:** ```bash npm install ``` -3. **Käynnistä kehityspalvelin:** +3. **Start the development server:** ```bash npm run dev ``` -4. **Rakennus tuotantoa varten:** +4. **Build for production:** ```bash npm run build ``` -5. **Esikatsele tuotantoversio:** +5. **Preview production build:** ```bash npm run preview ``` \ No newline at end of file