1.3 Submission Guidelines video - mariusb03/WebAndApplication-group-18 GitHub Wiki
Content in the Video Presenta.on
In general – you need to show that you have worked professionally, have learned what was taught in the course and have implemented the necessary elements for the project.
You need to present that in a video with the length between 12-15 minutes.
The presentation can be in English or Norwegian. If the presentation is in Norwegian, please, provide an English transcript. The transcript must not be 100% accurate, but it should represent the same things you mention in your video. (i.e., the meaning must be the same)
You can choose whether you create two separate videos (one for IDATA2301, one for IDATA2306), or one longer video for both courses. Just make sure you cover all the expected elements in your video(s).
See the suggested presentation structure below. All the described parts must be in the presentation. However, you can freely adapt the sequence of explanation so that it best fits within your story.
Suggested Video Presenta0on Structure for IDATA2301 Web Technologies
- Problem introduction. What task did you get assigned, what is your theme? What kind of shop is this? (0.5 - 1 minute)
- Work methodology. How did you use the typical soqware developer techniques to develop your project (Sprints, version control)? (0.5 – 1min)
- Architecture of the solution. Explain the overall architecture – is it monolith or decoupled? On one server or on two different servers? What authentication do you use? What database is used? (0.5 – 1min)
- Design decisions and agreements. Have you made any specific design decisions? What have you discussed with the customer (teachers) during the semester? For example, what was decided regarding the search options, or the currency? Clarify these decisions here. (0.5-1min)
- Design guideline. Show the design guideline. Mention how much of it is used in the result. In case there are deviations, reflect on the reasons why the result differs from the plan. (1 min)
- Wireframes. Show the initial wireframes you have sketched. Shortly explain how you were thinking when sketching the whole page structure. (0.5 – 1min)
- Demo of the functionality. Start with showing the main workflow – from opening the page, to searching for products and placing an order. Aqerwards you can show the extra functionality you have got. (3-6 min)
- Responsiveness. Show the responsiveness of your site. How does it look on a desktop and on a mobile? (0.5 min)
- Accessibility and usability. Reflect on the accessibility of your site. Have you paid aaention to semantic elements? What techniques have you used? Perhaps show the result of Lighthouse validator test. In case something is missing there, reflect on the reasons. How about Don Norman’s principles. Do you have any examples on where these principles are expressed in your user interface? (0.5 – 1min)
- Extras. Summarize what extras you have implemented in the project. What brings it up from a C-grade to an A-grade? (0.5 – 1min)
- Reflection. What have you learned in the course? (1 min)
Suggested Video Presenta0on Structure for IDATA2306 Applica0on Development
The first part can be the same as in IDATA2301 Web technologies (you can even reuse the same part of the video, if you work with video editing):
- Problem introduction. What task did you get assigned, what is your theme? What kind of shop is this? (0.5 - 1 minute)
- Work methodology. How did you use the typical soqware developer techniques to develop your project (Sprints, version control)? (0.5 – 1min)
- Architecture of the solution. Explain the overall architecture – is it monolith or decoupled? On one server or on two different servers? What authentication do you use? What database is used? (0.5 – 1min)
- Design decisions and agreements. Have you made any specific design decisions? What have you discussed with the customer (teachers) during the semester? For example, what was decided regarding the search options, or the currency? Clarify these decisions here. (0.5-1min)
The second part is specific for IDATA2306 Application development:
- Database schema. Show the table and relations between them. You can generate the schema with different tools. For example, show “ER Diagram” in DBeaver. (1 min)
- API endpoint documentation. List all the API endpoints, describe them shortly – the URL, request structure, response structure, return codes. The easiest, probably, is to use Swagger-generated documentation. In case you don’t use Swagger, describe the endpoints in another way. Don’t use much time by discussing the details of every endpoint, just list them. (0.5-1 min)
- User roles. Describe the user roles shortly – what user groups (roles) do you have? What is accessible to each group? (0.5 min)
- Demo of the functionality. Walk through the main workflow – from opening the page, to searching products and performing a checkout (placing an order). Which endpoints are involved where? You don’t need to spend very much time explaining specific code lines. Source code will be checked by examiners separately. But you can mention the main principles here. Have you separated the code in layers according to best practices? (Service, Repository, Controller). What is responsibility for each layer? You can take some use case, for example, one request. Then walk through that request handling from receiving the request in the controller (perhaps mention security sehngs as well), to the SQL request in repository. Here you have some room for improvisation. (3-6 min)
- Tests. Demonstrate the tests you have. Explain what you are testing, show the tests in action. This should be Postman test collection (or several collec*ons) by default, but you may have also other tests: Mock MVC tests, for example. (1-3 min)
- Extras. Summarize what extras you have implemented in the project. What brings it up from a C-grade to an A-grade? (0.5 – 1min)
- Reflection. What have you learned in the course? (1 min)
Deadline
The deadline to hand in all the necessary deliverables on Inspera in both courses is TBD, 2024, 12:00 (lunch time, not midnight!)