webbutveckling-backend

The markdown behind the website for webbutvckling backend

Fia webbapplikation

Introduktion till projektet

I projekt 1 har ni utvecklat en spelmotor (GameEngine) som håller håller koll på alla regler i ett fia spel.

I projekt 2 har använt denna spelmotor till att bygg ett Web API, datta API gör det möjligt att starta ett fia spel och för flera spelere att delta i spelet, även möjligt att ha igång flera samtidiga spel, på servern.

Överblik över delar projekt

Målet i detta projekt är att bygga ett grafisk Fia spel som en webbapplikation och att denna webbapplikation ska använda vårt Fia WebAPI till att hålla koll på all logik.

I den webbapplikation som vi ska bygga är planen att vi ska använda så många av dom teknikker som vi har lärt under kursensgång.

Grundtanken

Det ska vara möjligt att spela spelet för mellan två och fyra spelare, sittande på varje sin dator.

Det ska bara möjligt att starta fler samtidiga spel, på servern, och komma åt ett spel med en given länk.

Där är ingen krav på säkkerhet (finns dock med i VG).

Krav till projektet

Allt ni gör skall göras i ert GitHub repo (båda kod och dokumentation), som ligger på ert Team. Ni skall använda en “commit tidigt och ofta” (1) strategi, såklart bör ni endast commita kod som kan kompileras. Ert repositiory ska vara konfigurerat så att det enda sätt att få in kod i master branchen är via pull requests (detta göras av underviseren), detta betyder att ni inte kan jobba direkt i master men får skåpa en ny branch som ni jobber i ett rekomenderat namn är: Development

Ni kan sen göra så många branches baseret på Development som ni önsker, och göra pull requests internt i teamen till Development-branchen. Men när projektet är slut är det innehållet av master som räcknas, så ni behöver att göra minst ett pull request från Devleopment till master under projektet med reviewers från ett annat team.

Dokumentation

Se till att skriv och uppdatera eran user stories (i docs mappen), så att dom passer med eran Web App. Om ni använder någon externa källor (båda kod och annat) ange dom i dokumentationen.

Evt dokumentation kan skrivas med markdown (.md) eller ett annat format som ni känner er bekväma med (.txt, .docx, .html, .pdf etc) (helt ett format i rå text), ni väljer själv om ni vill skriva på svenska eller engelska, enda krav är att filerna placeras i /docs mappen. Vissa delar kan vara svåra att beskriva med text och till dissa kan man med fördel för med bilder, bilder läggs också i docs-mappen och använder ni markdown kan ni länka till dom.

![Beskrivning av bild](bildnamn.jpg)

Gör också ett dokument (använder manual) som beskriver hur man spelar ert spel.

Programmering

I detta projekt ska ni implementera en Web App till ert Fia spel (Ludo på engelska). Spelet ska vara en ASP.NET Core Web Application (Model-View-Controller).

Kod ska ligga i mappen src, varje team får enbart ha en kodbas. Där finns i detta repository en gitignore-fil som passer till Visual Studio, i src-mappen finns även en tom solution, denna kan ni använda till att lägga till ert projekt.

Det rekomeneras att ni kopiere in ert Web Api och eran game engine i eran src-mapp.

Ni kan välja att ha WebApp, WebApi och GameEngine i eran solution, detta kan vara smidigt om ni ska behöva att debugga eller inte vill vara beroedende av ett API som kör live av nogon anledning. Men ursprungstanken är att ni håller WebAPI och WebApp som två sperate saker. Så att eran solution enbart kommer att innehålla en WebApp som anroper ett API som äntligen körs lokalt eller på en server.

Önsker ni inte att använda eran eget API, kan ni här hitta ett väldigt basic ludo game API: skjohansen/LudoGameApi

Bygg och deploy

Målet är att eran applikation ska kunna byggas och delpoyas en webbserver. Det enklaste är att göra en publish till en Azure Website i Visual Studio. Men bäst skulle det vara om ni kan lyckas att få till Continious Deployment med AzureDevops.

Hints

Börja med i teamen med att göra en förväntningsavstämning, vad är erat mål i team, och vad är er individuella styrkor.

Försök att undvika att någon i teamen är syssellösa, om där är samarbetsvanskligheter se till att ta i dom så tidigt som möjligt.

Om någon i gruppen har svårt vid delar av koden, försök att köra pair-programming, och se till at den om tycker det är svårt är Driver

Om ni sitter på distans träffas med video en gång per dag (via skype, google hangout, appear eller likande), och kör pair-programming via TeamViewer eller likande.

Använd Github aktivt: Issues, Pull requets, Projects. Det gör det enklare för alla hänga med på alla förändringar och idéer.

Försöka att följa SOLID principerna så långt det går.

Kom igång

  1. Beskriv med user stories vad ni förvänter att en använder ska kunna i ert fia spel *. Eventuelt: Beskriv för varje user storie ett eller fler scenarios, med Gherkin , dissa kommer att vara till stor hjälp som dokumentation när ni ska implementera funktionalitet i spelet.
  2. Skåpa en ASP.NET Core Web Application (Model-View-Controller)
  3. Lägg till en ny tom (empty) controller, kall den “LudoController”
  4. Skåpa en mapp under View, som hettar samma som din controller: “Ludo”
  5. I mappen Ludo, lägg till ett View som hetter samma som en action i din LudoController, där bode finnas in Index-action som standard. Lägg till index.cshtml i Ludo-mappen
  6. I Index viewen lägg eventuellt till HTML och css som är i för ett fia spel i examples/LudoBoardHtmlAndCss
  7. I controlern lägg in anrop mot ett Ludo api, i actions som mot svara det som du gärna vill göra
  8. Testa att starta applikationen

Anrop APIet från en annan applikation

Exempel på hur du kan använda och testa ett REST Web API med en konsol applikation (eller annat C# kod) Nuget paket: RESTSharp (Projekt på Github)

// Retrive the name of a specific Ludo game using the REST API
var client = new RestClient("http://someserver.com/api");

var request = new RestRequest("ludo/{id}", Method.GET);
request.AddUrlSegment("id", "123"); // replaces matching token in request.Resource
RestResponse<LudoGame> ludoGameResponse = client.Execute<LudoGame>(request);
var gameName = ludoGameResponse.Data.GameName;

Kolla evt denna artikel med olika tillgångar till hur man kan kommunicera med ett REST API: A Few Great Ways to Consume RESTful API in C#

Statiska ressource

I ASP.NET MVC ska statiska ressourser som CSS läggas i wwwroot mappen:

wwwroot folder

Och ressourserna som ligger där kommer man åt via HTML:

<link rel="stylesheet" href="~/css/site.css" />

Betygsättning

Detta projekt är betygsgrundande, och startas tisdag den 29:e januari 2019.

Det är dokumentation och kod som är commitat master-branchen innan torsdag den 21:e februari 2019 kl 10:00 som räcknas.

Branching och pull request

Ni kan göra så många branches baseret på master som ni önsker. När projektet är slut är det innehållet av master på GitHub som räcknas, så ni behöver att göra ett pull request eller merge från eran branch(s) till master innan deadline (om ni gör ett pull request kom ihåg att det måste appovas innan filerna hamnar i master).

Krav för G

Förslag till VG (G krav + minst 2 VG förslag)

För att ett VG kriterium kan godkänns krävs det att där i docs mappen finns ett matchande dokument med en beskrivning, namnet på dokumentet är angivet under varje kriterium, med ett förslag till vad innehållet av filen kan innehålla (filen måste vara namngivet med .md, men ni behöver inte använda Markdown formatering i filen).