README.md

MinVakt

Fiktivt system for vaktliste i helsetjenesten

Kodestrukur

• Backend-kode: src/main/java/no/ntnu/stud/minvakt
• Databasekommunikasjon: src/main/java/no/ntnu/stud/minvakt/database
• REST-kode: src/main/java/no/ntnu/stud/minvakt/services
• Dataklasser (f.eks. User): src/main/java/no/ntnu/stud/minvakt/data
• Backend-logikk: src/main/java/no/ntnu/stud/minvakt/controller
• Backend-test: src/test/java/no/ntnu/stud/minvakt
• Hjelpeklasser/verktøy: src/main/java/no/ntnu/stud/minvakt/util
• Frontend/web: src/main/webapp

Kodekonvensjon

Generelt

• All kode skal være på engelsk. Dette gjelder også kommentarer, git-commits og databasen

Java

• Vi tar i bruk standard Java-navnekonvensjon: http://www.oracle.com/technetwork/java/codeconventions-135099.html
• REST-API, data og logikk skal separeres, se pakkene i Kodestruktur. Hvis kode ikke passer i noen av disse, kan det foreslås flere pakker.

• Klassenavn:
  • REST-servicer: -Service (F.eks. UserService)
  • Testklasser: Klassen som skal testes + Test (F.eks. testklasse for UserService skal være UserServiceTest)
  • Databaseklasser (i database-pakken): -DBManager (F.eks. UserDBManager)

Frontend

• Vi tar i bruk W3s praksis:
• http://www.w3schools.com/js/js_conventions.asp
• http://www.w3schools.com/js/js_best_practices.asp
• http://www.w3schools.com/html/html5_syntax.asp

Database

• Tabellnavn skal vanligvis være substantiv i entall, og bør være selvforklarende (F.eks. user og ikke users)
• Både kolonnenavn og tabellnavn skal være i lowercase, og ord skilles med underscore (_) (F.eks. first_name og ikke FirstName eller firstname)
• Løpenummer-kolonner bør hete "id" (F.eks. user.id og ikke user.user_number)