Forprosjektrapport. Sammendrag. Hovedoppgave våren 2019 Gruppe 3

Transkript

1 Forprosjektrapport Hovedoppgave våren 2019 Gruppe 3 Sammendrag Vi skal overføre en eksisterende nettside over på en ny plattform samt legge til noe tilleggsfunksjonalitet. Hovedutfordringene ved den eksisterende løsningen er at den er treg, lite skalerbar og vanskelig å videreutvikle. Gruppens hovedoppdrag er å løse disse problemene ved å gjenoppbygge dagens løsning fra bunnen av, samt implementere noe tilleggsfunksjonalitet.

2 Presentasjon 2 Medlemmer av prosjektgruppen 2 Oppdragsgiver 2 Kunde via oppdragsgiver 2 Kontaktpersoner 3 Oppgave 3 Dagens situasjon 4 Balance Tool 4 Utfordringer ved Balance Tool 4 Mål og rammebetingelser 5 Arbeidsmetodikk 5 Funksjonalitet 5 Fremdriftsplan 6 Løsning 7 React 7 Spring Boot 7 Alternativ til løsningen 7 Teknologi 8 Analyse av virkninger 9 Hastighet 9 Skalerbarhet og videreutvikling 9 Brukervennlighet 9 1

3 Presentasjon Medlemmer av prosjektgruppen Miina E. Lervik Lars Ree Elise Haram Vannes Aleksander Helgaker Alle gruppens medlemmer har jobbet sammen tidligere i andre fag og vi samarbeider godt. Vi har en god fordeling av kodepreferanser med Elise og Lars som backender, og Aleksander og Miina som frontender. Oppdragsgiver Netcompany Henrik Ibsens gate Oslo Netcompany er et IT-konsulentfirma som leverer end-to-end løsninger. Sammen med dem skal vi utvikle en tjeneste for en kunde de har funnet til oss. De stiller med prosjektleder, kunde, og tekniske veiledere. Kunde via oppdragsgiver ShesGotThis, også kjent som HunSpanderer, startet som en frivillig organisasjon som arbeider for å sette ubevisst kjønnsdiskriminering på agendaen. De retter seg spesielt mot næringslivet og søker å skape likestilling på arbeidsplassen. 2

4 Kontaktpersoner Prosjektleder fra Netcompany: Henrik Alfredsen Tlf: E-post: Veileder på OsloMet Torunn Gjester Tlf: E-post: Gruppeleder Aleksander Helgaker Tlf: E-post: Oppgave Kundens eksisterende løsning, både frontend og backend, skal gjenoppbygges fra bunnen av. Målet med dette er at løsningen skal bli skalerbar, og enklere å videreutvikle. Den nye løsningen skal i stor grad se ut som og fungere som den eksisterende løsningen, med noe tilleggsfunksjonalitet. 3

5 Dagens situasjon Balance Tool ShesGotThis tilbyr produkter og tjenester til virksomheter som ønsker å kartlegge og forbedre kjønnsbalansen i sin bedrift. De har utviklet webapplikasjonen 1 Balance Tool som måler kjønnsbalansen i de registrerte bedriftene basert på en rekke forskjellige indikatorer. Eksempler på noen indikatorer er lønn og ansiennitet. Løsningen skal hjelpe bedriftene å få en oversikt over kjønnsfordeling, samt kjønnsforskjellene i bedriften. Den kommer også med forslag om tiltak til forbedringer slik at bedriftene kan nyte godene av økt mangfold. ShesGotThis bruker også informasjonen de mottar via webapplikasjonen til forskning. ShesGotThis tilbyr en tilnærming som kan bidra til å finne nøkkelen til å oppnå 2 reell balanse, og derved bedre måloppnåelse og økonomiske resultater. Utfordringer ved Balance Tool Det har kun vært én utvikler til koding av nettsiden deres og det er mye som kan forbedres. Backend er i dag skrevet i Python-rammeverket Django. Det er mange kodelinjer og koden er noe uoversiktlig, noe som gjør det vanskelig for andre personer å videreutvikle produktet. ShesGotThis ønsker på sikt å legge til mye tilleggsfunksjonalitet som vil gjøre brukeropplevelsen bedre for de som benytter seg av tjenesten. Det er viktig at siden blir skalerbar, noe Netcompany mener den ikke er i dag. Nettsiden oppleves også som treg. Det kan ofte ta opp mot 5 sekunder å laste en side med dagens løsning. En utfordring med dagens løsning er også at man må manuelt fylle inn informasjon i alle inputfeltene når man registrerer tall fra sin bedrift. Dette er en tidkrevende jobb som kan oppleves som et hinder for å bruke tjenesten. Siden er Sitat fra: 4

6 heller ikke responsiv slik den er i dag og fungerer derfor ikke optimalt på mobile enheter. Mål og rammebetingelser Dagens løsning skal gjenoppbygges fra bunnen av, både frontend og backend. Løsningen skal både se ut som og fungere som dagens løsning, men skal overføres til en ny kodebase. Målet er å bedre skalerbarheten, hastigheten og å forenkle muligheten for videreutvikling. ShesGotThis har mange ideer til tilleggsfunksjonalitet. Et hovedønske er å forenkle utfylling av data ved å muliggjøre automatisk innhenting av disse fra bedrifters eksisterende HR systemer. Netcompany har allerede definert, i samarbeid med kunden, teknologien som skal benyttes. Mer om teknologien vi skal beskrives i avsnittet Løsning. Arbeidsmetodikk Prosjektgruppen skal bruke scrum som arbeidsmetode. Dette vil innebære daglige standups, og demo etter hver sprint. Dette vil sikre at alle i teamet er oppdatert på hva de andre gjør og vi får delt lærdom og erfaringer. Det skal gjennomføres automatiske tester gjennom hele utviklingsperioden. Testingen skal sørge for at feil oppdages tidlig, og at koden er lesbar, robust og enkel å vedlikeholde. Med en smidig tilnærmingsmetode skal vi raskt kunne oppdage om vi er på riktig spor eller ikke, og vi vil ha mulighet til å justere målene underveis. JIRA vil bli brukt til prosjektstyring og fungere som samlingsplass for backlog og brukerhistorier. Vi skal dokumentere hele prosessen i Confluence og Google drive. Funksjonalitet Følgende funksjonalitet er det som i dag tilbys i løsningen. I tillegg har vi lagt på den tilleggsfunksjonaliteten som er ønsket. Login-funksjon for bedriftene 5

7 Infoside om ShesGotThis Kontaktside for ShesGotThis Godkjenningsfunksjon hvor admin kan godkjenne at bedriften som har registrert seg faktisk er den de utgir seg for å være Mulighet for å endre kontaktperson for bedriften Registreringsfelt for tall fra bedriftene En løsning for oppkobling mot bedriftens egne HR-systemer for automatisk utfylling av data Mulighet for at bedriftene kan endre/oppdatere tallene sine Fremvisning av statistikk basert på bedriftens egne tall Fremvisning av statistikk hvor bedriftens tall sammenlignes med et gjennomsnitt fra alle de registrerte bedriftene Mulighet for eksportering av statistikk til pdf og csv Fremdriftsplan En sprint vil innebære programmering både backend og frontend. Testing vil skje i slutten av hver sprint. De første fem sprintene vil kun fokusere på å få den nye tekniske plattformen i stand. De neste tre vil ha fokus på utvikling av API for automatisk utfylling av data, samt annen tilleggsfunksjonalitet hvis vi får tid. 6

8 Løsning React Frontend til nettsiden skal utvikles i React. React gjør det enklere å utvikle nettbaserte Single Page Applikasjoner. Dette har flere fordeler. Det er blant annet enklere å utvikle gjenbrukbare komponenter, og det er enklere å vise oppdatert informasjon i webapplikasjonen. Komponentene vil automatisk oppdatere seg selv for å reflektere endringer i tilstanden. React er også bygget for å være raskt. Kun data som faktisk endrer seg vil bli rendret på nytt i applikasjonen. React har etterhvert blitt svært utbredt, og det skal derfor være relativt enkelt å finne personer for å videreutvikle løsningen. En ulempe er at informasjonsflyten gjennom komponenthierarkiet raskt kan bli uoversiktlig og vanskelig å håndtere. Dette planlegger vi derfor å løse ved å benytte en state management container ved navnet Redux. Redux er valgt siden dette er den mest utbredte av state management container løsninger. Spring Boot Vi skal bruke Spring Boot for backend. Bruk av Spring Boot er svært utbredt i bransjen, noe som gjør den egnet til dette prosjektet med tanke på videreutvikling. Som nevnt ønsker ShesGotThis å legge til mye funksjonalitet på sikt, så et viktig kriterie for koden er at det blir enkelt for fremtidige utviklere å sette seg inn i det vi lager iløpet av prosjektet. Det å bruke kjente kodespråk (Java) og rammeverk vil kunne gjøre det enklere å finne folk som kan jobbe videre med løsningen. Alternativ til løsningen Løsningene beskrevet i forprosjektet er det Netcompany og ShesGotThis sammen har kommet frem til. Derfor har vi ingen alternative løsninger. I tillegg er det viktig å påpeke at ettersom vi jobber smidig i iterasjoner vil vi hele tiden være i dialog med kunden om at løsningen vi jobber med er den riktige. Justeringer vil foregå kontinuerlig i utviklingsprosessen. Dette betyr at hvis vi underveis ser at vi 7

9 burde gjøre noe på en annen måte vil dette fanges opp tidlig slik at vi kan endre kurs. Teknologi Følgende er en oversikt over teknologier vi planlegger å benytte. Merk at denne listen kan endres underveis da vi jobber smidig. Github For versjonshåndtering Java/Spring Boot/Lombok Swagger React + Redux PostgreSQL Azure Docker Til backend og API. Spring Boot benyttes blant annet for å kjøre programmet på en server. Lombok forenkler koden slik at det ikke er nødvendig å lage blant annet gettere og settere. Skal brukes som hjelpemiddel for å sette opp API. Dette vil opprette en rekke filer for oss, hvor det vil bli aktuelt å override noen av dem. 3 Nettsiden skal utformes som en SPA i rammeverket React. Tilstand i webapplikasjonen skal håndteres ved bruk av Redux. Databasehåndteringssystem som skal brukes as a service Skal brukes som server hvor nettsiden blir hostet, og sikre at vi får på plass et testmiljø. Nettsiden skal lagres i en Docker-container, som brukes til å enkelt laste opp nettsiden til Azure Frontend, backend postgres Docker compose eller lignende for koordinering 3 Single Page Application 8

10 Analyse av virkninger Hastighet Den nye nettsiden vi skal lage vil gjøre siden raskere enn det den er i dag. Dette er fordi vi går over til å bruke React. I React er det kun de delene av siden som endres som vil bli rendret på nytt ved bruk av siden. F.eks hvis vi har en menybar som åpner forskjellige sider vil man i vanlig HTML oppleve at hele menybaren må rendres på nytt. I React vil menybaren som ikke opplevde noen endringer forbli uendret, mens den nye delen som lastes inn vil være det eneste som oppdateres på siden. Skalerbarhet og videreutvikling Skalerbarhet er en viktig del av den nye løsningen. Det å benytte Docker og å hoste siden på Azure vil sikre at man kan utvide etter behov. Ettersom siden skal videreutvikles i fremtiden er det også viktig at andre utviklere lett kan sette seg inn i det arbeidet vi har gjort. Det å benytte teknologier og følge bransjestandarder som mange utviklere kjenner til vil gjøre det enklere for nye utviklere å jobbe videre på siden i fremtiden. Vi skal også fokusere på god dokumentasjon og forklarende navn i metoder og variabler slik at andre kan forstå hva hver metode gjør og hva variablene i koden brukes til. Brukervennlighet Løsningen for å hente ut informasjon fra bedriftenes egne HR-systemer vil gjøre siden enklere å bruke. Det vil spare tid og krefter for de som ønsker å registrere sin bedrift på nettsiden. Vi skal gjøre siden responsiv, noe som vil gjøre den mer brukervennlig, samt mer tilgjengelig over flere plattformer. Vi kommer også til å gjøre små endringer i designet for å gjøre det lettere for brukeren å forstå hvordan nettsiden skal brukes. 9