Update README.md

2024-10-15 17:57:30 +00:00
parent 41074e5a15
commit c302743188
1 changed files with 47 additions and 26 deletions
@@ -1,38 +1,59 @@
-# create-svelte
+# Levyraati Revived

-Everything you need to build a Svelte project, powered by [`create-svelte`](https://github.com/sveltejs/kit/tree/main/packages/create-svelte).
+## Overview

-## Creating a project
+**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.

-If you're seeing this, you've probably already done this step. Congrats!
+> ⚠️ 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!

-```bash
-# create a new project in the current directory
-npm create svelte@latest
+## Features

-# create a new project in my-app
-npm create svelte@latest my-app
-```
+- **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.

-## Developing
+## 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.**

-Once you've created a project and installed dependencies with `npm install` (or `pnpm install` or `yarn`), start a development server:
+## 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.

-```bash
-npm run dev
+## License

-# or start the server and open the app in a new browser tab
-npm run dev -- --open
-```
+This project is licensed under the MIT License - see the LICENSE file for details.

-## Building
+## Installation & Setup

-To create a production version of your app:
+1. **Clone the repository:**
+    ```bash
+    git clone https://git.kessinen.com/Kessinen/levyraati2024-frontend.git
+    cd levyraati-2024
+    ```

-```bash
-npm run build
-```
-
-You can preview the production build with `npm run preview`.
-
-> To deploy your app, you may need to install an [adapter](https://kit.svelte.dev/docs/adapters) for your target environment.
+2. **Install dependencies:**
+    ```bash
+    pnpm install
+    ```
+3. **Start the development server:**
+    ```bash
+    pnpm run dev
+    ```
+4. **Build for production:**
+    ```bash
+    pnpm run build
+    ```
+5. **Preview production build:**
+    ```bash
+    pnpm run preview
+    ```