Initial commit

2024-10-11 19:44:42 +03:00
commit 8435186706
17 changed files with 2630 additions and 0 deletions
@@ -0,0 +1,59 @@
+# Levyraati 2024
+
+## Overview
+
+**Levyraati 2024** 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.
+
+> ⚠️ 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!
+
+## Features
+
+- **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.
+
+## 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.**
+
+## Technologies Used
+- SvelteKit: For building the app’s user interface and handling routing.
+- SQLite: Lightweight default database (easily swappable for other databases like PostgreSQL for production).
+- Tailwind CSS: For styling and responsive design.
+- JavaScript / TypeScript: Primary languages for scripting and functionality.
+- Vite: For fast builds and hot module replacement.
+- YouTube API: (optional) for handling YouTube links if needed.
+
+## License
+
+This project is licensed under the MIT License - see the LICENSE file for details.
+
+## Installation & Setup
+
+1. **Clone the repository:**
+    ```bash
+    git clone https://git.kessinen.com:3000/Kessinen/levyraati2024-frontend.git
+    cd levyraati-2024
+    ```
+
+2. **Install dependencies:**
+    ```bash
+    npm install
+    ```
+3. **Start the development server:**
+    ```bash
+    npm run dev
+    ```
+4. **Build for production:**
+    ```bash
+    npm run build
+    ```
+5. **Preview production build:**
+    ```bash
+    npm run preview
+    ```