From 4115a0cee9c7bb5562528e5a0aa8f177984c04cd Mon Sep 17 00:00:00 2001 From: Ellen Date: Thu, 1 Oct 2026 13:50:43 +0200 Subject: [PATCH] skrive inn beskrivelse for konsept (Closes #2) --- README.md | 34 ++++++++++++++++++++++++++++++++++ 1 file changed, 34 insertions(+) diff --git a/README.md b/README.md index 2d31cb6..1dfb1a0 100644 --- a/README.md +++ b/README.md @@ -7,6 +7,40 @@ Currently, two official plugins are available: - [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react) uses [Oxc](https://oxc.rs) - [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react-swc) uses [SWC](https://swc.rs/) +## Prosjektbeskrivelse (CDllection) + +### Konsept + +En katalog for musikkalbum, fysisk mediesamling og utgivelser der brukeren kan søke etter album. Søkefeltet kan fileteres ute fra sjanger, vurdering og utgivelsesår. Brukere kan gi vurdering og skrive anmeldelser som andre brukere kan også se. Brukeren kan lagre albumer til favoritter. For brukere som aktiv samler på fysisk media (CD/vinyl), så har de også muligheten til å lagre Albumer utefra om de har kjøpt disse fysisk eller ikke. + +### Datasett + +Bruke et poent datasett fra Kaggle (alternativt MusicBrainz) som datakilde for albumkatalogen. Dataen importes en gang med et eget importskript og lagres i vårt egen database for prosjektet. Applikasjonen kaller da ikke eksterne API-er under kjøring. Filterering, søking og sortering skjer mot vår egen database via GraphQL-backenden. + +- Kilde: https://www.kaggle.com/datasets + +### Brukergenerte data + +Dataen til brukeren lagres permanent i databasen: + +- Person uten bruker kan filtrere, søke etter album og lese anmeldelser. De kan derimot ikke lagre noe data. +- Brukere kan gi vurderinger av album og skrive plateanmeldelser som er da synlig for andre brukere +- Brukere kan lagre album i tre forskjellige collection: + - "Favorite albums” + - “Own”: her kan brukere lagre albumer de har som fysisk media + - “To Buy”: her kan brukere lagre albumer de ikke har som fysisk media ennå + +### Innlogging + +Det skal være mulig å lage bruker. Man kan fortsatt bruke nettsiden uten bruker, men dette blir da begrensent. Det er kun brukere som kan skrive anmedelser og lagre albumer til samlinger. + +### Søk, filtrering og interaksjon + +Brukeren kan søke på enkeltord i søkefeltet. Søket er case-insensitivt og matcher på albumtittel og/eller artistnavn. Søkeresultatet vises som en liste over album som samsvarer med søket, og lastes inn i deler (paginering eller infinite scroll), slik at store resultatsett håndteres effektivt. + +Resultatet kan filtreres på utgivelsesår, sjanger og vurdering (1-5 stjerner), og sorteres på for eksempel år, tittel og gjennomsnittsrating. Søk, filtrering og sortering utføres i databasen og gjelder hele resultatsettet, ikke bare det som er lastet inn i nettleseren. Brukeren kan klikke seg inn på et album for å se mer informasjon, blant annet tracklist, artistnavn, utgivelsesdato, sjanger og label. Detaljsiden viser også gjennomsnittsrating og anmeldelser fra andre brukere. + + ## React Compiler The React Compiler is not enabled on this template because of its impact on dev & build performances. To add it, see [this documentation](https://react.dev/learn/react-compiler/installation).