ppessi / kurssiesitieto-ohtuprojekti

Ohjelmistotuotantoprojekti, kevät 2024

Course Prerequisite visualization tool

This project is a web application designed to help students plan their studies by showcasing hierarchical relations between different courses. The app is built with React and Vite with the aim of creating intuitive and interactive way to visualize the relations between different courses. The project fetches course data from Sisu and will later take advantage of University of Helsnki login to fetch students personal data to help students further plan their studies.

This project is part of Software engineering course in University of Helsinki (Ohjelmistoprojekti TKT20007)

Link to the visualization tool

Table of Contents

• Prerequisite course visualization tool
• Table of Contents
• Documentation
• Project links
• Quickstart
  • Downloading
  • Installation
  • Setting up env
  • Running the program locally

Documentation

• Definition of done
• Roles for the meetings
• For developers

Project links

• Backlog
• Timesheet
• Minutes of meetings

Quickstart

Downloading

Run the following command in the terminal:

git clone [email protected]:Kurssiesitieto/kurssiesitieto-ohtuprojekti.git

Installation

Run the following command in root directory:

npm install

Installs the required dependencies on both frontend and backend

Setting up .env

Set up .env file in project root. Follow this guide for the required variables.

Running the program locally

Running the program in development mode:

npm run dev 

To run the program in production mode, you need to execute the following two commands:

npm run build 
npm run prod

Runs the app on http://localhost:3001/

Where does the application go on it's day off? nowhere the application can't walk silly.