From 8797e523130ba6976355cac662eff52c200ea6cf Mon Sep 17 00:00:00 2001 From: stinejs Date: Thu, 1 Oct 2026 14:58:53 +0200 Subject: [PATCH] short project plan to keep the group on track (Closes #9) --- Documents/COMMANDS.md | 6 ++--- Documents/PROJECT_PLAN.md | 48 +++++++++++++++++++++++++++++++++++++++ 2 files changed, 51 insertions(+), 3 deletions(-) diff --git a/Documents/COMMANDS.md b/Documents/COMMANDS.md index ec3d18d..9c18e89 100644 --- a/Documents/COMMANDS.md +++ b/Documents/COMMANDS.md @@ -7,7 +7,7 @@ This document include a selection off git commands, that are used when working t ```bash git checkout main git pull -git checkout -b feature/issue-#number-description +git checkout -b feature/issue-number-description ``` ## Saving and pushing changes @@ -15,7 +15,7 @@ git checkout -b feature/issue-#number-description ```bash git add . git commit -m "short description of what was done (Closes #number)" -git push -u origin feature/issue-#number-description +git push -u origin feature/issue-number-description ``` ## Updating your local main branch @@ -30,7 +30,7 @@ git pull ```bash git checkout main git pull -git branch -d feature/issue-#number-description +git branch -d feature/issue-number-description ``` ## View local branches diff --git a/Documents/PROJECT_PLAN.md b/Documents/PROJECT_PLAN.md index e69de29..7c1a8e5 100644 --- a/Documents/PROJECT_PLAN.md +++ b/Documents/PROJECT_PLAN.md @@ -0,0 +1,48 @@ +# Prosjektplan – CDllection + +## 1. Mål og Konsept +*CDllection* er en webapplikasjon bygget med React, TypeScript og Vite. Applikasjonen lar brukere utforske et fyldig lydarkiv, filtrere på tiår, sjanger og vurderingen, samt gi egne vurderinger (reviews). Album kan lagres i spesifiserte lister. I tillegg kan brukere teste sine kunnskaper i en interaktiv Lyd-Quiz. + +--- + +## 2. Underveisinnleveringer +- Første underveisinnlevering skal kun være en spesifikasjon eller utkast til systemet med mockup-data eller statiske kodet eksempeldata etc. Målet med innleveringen er å komme i gang, vise frem egen ide og få tilbakemeldinger, se hva andre har planlagt av løsninger. Ingen strenge krav annet enn at medstudenter skal kunne sette seg inn i hvilke data dere har tenkt å bruke, hvordan applikasjonen er tenkt utformet mtp visning av data, interaksjon med resultatet etc. +- Andre underveisinnlevering skal ha en kjørende database og backend på vm - og klienten skal støtte noe interaksjon. Her er fokus på fungerende samspill mellom klient og backend, riktig oppsett, installering og kjøring av backend. +- Tredje underveisinnlevering bør i praksis være en første fullstendig prototyp (beta-versjon), som skal gi et godt grunnlag for utprøving og kvalitetssikring av funksjonelle egenskaper som søk, blaing, sortering og filtrering. Her ser vi også på hvordan dere løser kravene til bærekraftig utvikling og tilgjengelighet. +- Fjerde underveisinnlevering bør i praksis være et ferdig prosjekt, men med mulighet til å endres under eller etter medstudentvurdering mtp sluttvurderingen. Her vurderer vi også alle aspekter ved applikasjonen som nevnt over men ser også på testing. + +## 3. Leveranseoversikt + +### Innlevering 1: Prosjektoppsett, skisser og spesifikasjon +- [x] Prosjektarkitektur med Vite, React og TypeScript +- [x] Felles VS Code-innstillinger (`extensions.json`, `settings.json`) og Prettier +- [x] Skisser for utseende av webapplikasjonen +- [x] Opprettelse av `PROJECT_PLAN.md`, `COMMANDS.md` `TIME_USAGE.md` og `AI_USAGE.md` +- [ ] Skrive Mockup, både når det gjelder data, samt frontend + +### Innlevering 2: Kjernefunksjonalitet & State +- [ ] Ta inn data +- [ ] Filtrering på Tiår og Sjanger +- [ ] Komponent for å legge til brukeranmeldelse (Rating & Kommentar) +- [ ] Lagring av egne albumlister i `localStorage` + +### Innlevering 3: Tilgjengelighet, Ytelse & Dokumentasjon +- [ ] Filtrering basert på brukeres reviews +- [ ] Full WCAG/a11y-sjekk (tastaturnavigasjon, ARIA-labels) +- [ ] Ytelsesoptimalisering og Grønn IT-tiltak + +### Innlevering 4: Ferdigstilling +- [ ] Gjennomgang av all feedback +- [ ] Sluttføring av prosjektdokumentasjon og AI-logg +- [ ] Fullestendig fungerende webappliskasjon + +--- + +## 3. Ansvarsområder +Oppgavene fordeles ved hvert møte. Da går vi igjennom hva som allerede har blitt gjort, og hva som mangler. Dette gjør vi ved å assigne issues i git. Ved å gjøre det slik, blir det lettere å holde styr på arbeidsmengden. Ønsket er at alle skal jobbe like mye med prosjektet, og at alle lærer. + +--- + +## 4. Arbeidsmetodikk +- **Git Flow:** Alle nye funksjoner utvikles på egne feature-brancher (`feature/issue--beskrivelse`). +- **Code Review:** Alle Merge Requests må gjennomgås og godkjennes av minst én medstudent før sammenslåing med `main`. \ No newline at end of file