Skip to content

Home

Jump to bottom
Kristian Kähkönen edited this page Oct 16, 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 XXXXXX. Made by @HenriSjoblom, @kristianka and @Zennrr!

Ways of working

Project leader is Kristian Kähkönen. 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 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. Communication is done via Microsoft Teams. Meeting once or twice a week.

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

Running the app

Requirements:

  • VS Code or similiar text editor / IDE
  • Node.js / NPM
  • Supabase account
  • OpenAI API key

Development

First install the node_modules and run the application in development mode:

  1. npm i
  2. Setup .env.local values based on .env.example
  3. npm run dev

Production

First install the node_modules, then build the application and finally start it:

  1. npm i
  2. Setup .env.local values based on .env.example
  3. npm run build
  4. npm run start

Tests

TBD

Live deployment

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

Clone this wiki locally