1.2 Submission Guidelines insperia - mariusb03/WebAndApplication-group-18 GitHub Wiki

Deliverables to hand in

The following deliverables must be delivered in Inspera:

  • Link to source code GIT repository. If you used separate repositories for the frontend and backend, provide link to both of those. If during the semester several students had “their own project repository” (which is a rela*vely bad practice – you should have collaborated on the same repo instead), provide all of those.

  • README.md file(s) – at the root of the project folder. No need to hand in anything specifically, just make sure that you GIT repository contains a README file. You can have two separate READMEs (one for the backend, one for frontend) in the respective folders. The target audience for the README are developers and next students. Include the following in the README:

    • A short description of the project
    • “Gehng started” – how to run the project, what is necessary (environment variables, database(s))?
    • One or a couple of screenshots of your website (for the frontend part).

  • Video presentation (video file) of the project, see content requirements below.

  • URL of the website in production. It is expected that the website is deployed on a server. The website must be accessible during the whole examination period (and eventual complaints (klagesensur)).

  • Sprint reports. No formal definition of the format. This can be, for example a markdown file stored in the same Git repository. You need to show:

    • When did you work with the project – which weeks?
    • What was the goal in each sprint?
    • How was the work distributed among group members? Who got assigned to which tasks?
    • What was accomplished in each sprint?

  • For IDATA2301 the following additional deliverables are required either as links to online-files or PDF files:

    • Design guideline.
    • Wireframes.

  • For IDATA2306 the following addi*onal deliverables are required:

    • Database schema. Show the table and relations between them (PDF or PNG file). You can generate the schema with different tools. For example, take screenshot of “ER Diagram” in DBeaver. An example of what is expected:
      image

  • Postman test collection(s) – either a link to the collections online or a .JSON file containing the test collection. If you wrote other types of API endpoint tests (for example, Java tests with MockMvc), write a comment about it instead of providing a link to the tests.

Deadline

The deadline to hand in all the necessary deliverables on Inspera in both courses is TBD, 2024, 12:00 (lunch time, not midnight!)