Skip to content
Henri Sjöblom edited this page Nov 12, 2024 · 11 revisions

Project info

Study tutor is a software for students and everyone who wants to learn new skills and keep track of the progress! Live at Study Tutor. Made by @HenriSjoblom, @kristianka and @Zennrr!

Ways of working

Main branch is secured and cannot be pushed to directly. Every change has to go through a pull requests, where building and linting is done. After those pass, one person does a through code review and provides feedback and suggests changes if necessary. Pull request descriptions are detailed and if there's a questionable solution, it's explained why it was done like that and why some other way didn't work.

We will use GitHub Wiki (the thing you are reading now) for through documentation of the project and meetings. The team will also utilise GitHub issues and GitHub Projects for project managing. GitHub Discussions offers a Kanban board, where a team member can create cards and assign them. Transparency between team members is critical. The project will fail if a team member over-promises and under-delivers. It is preferred to under-promise and over-deliver. Stuff happens in real life, delays are expected and perfectly fine.

Project leader is Kristian Kähkönen and Product owner is Henri Sjöblom. Project leader's responsibility is to make the project a success. These include managing weekly meetings, helping with issues know what everybody is doing and when and et cetera. Project leader manages the Kanban board and Wiki and also gives constructive feedback during code review and suggests improvements.

Definition of success, final product:

  • Has minimal bugs
  • Is secure
  • Has great performance
  • Has through documentation.

In addition to these, it's important everybody has learned something new since this is a school project. The project is going to be a polished full stack application, our team won't just go at the minimum requirements for the course. We are targeting for the maximum grade and have a early deadline to complete the project a month in advance to others. Communication is done via Microsoft Teams. Meeting once or twice a week, active communication via Teams and Discord/WhatsApp direct messages.

Definition of Done

  • No major bugs
  • Design is consistent
  • Scales on mobile and desktop
  • Code is cleaned up
  • Packages are up-to-date
  • Product has been tested to be safe
  • Through tests exist and pass
  • Final product is publicly available to everyone

Live deployment

You can checkout the app at Study Tutor :) Links to other pages on sidebar!

Clone this wiki locally