<<<<<<< HEAD

Learniverse

everything to make your studies easier

Table of Contents

1. About The Project
   • Main Functions
   • Built With
   • Project Demo Video
2. Getting Started
   • Prerequisites
   • Installation
3. Folder Structure
4. Tests
• E2E-Tests (Playwright)
• Unit-Tests (Jest)
5. License
6. Contact

About The Project

Learniverse is a learning platform specifically for the Media Informatics course. Users can make tutoring requests, use a plotting tool to graphically display mathematical formulas and review the content of individual subjects for optimal exam preparation. The footer of the page contains links to the imprint.

Main Functions:

• YouTube videos on the individual chapters of the modules
• Chatbot: Artificial intelligence for answering questions
• Graphtool: Visualization of mathematical functions

Built With

• Next.js - Framework for server-side rendering and API routing
• React - JavaScript library for the user interface
• YouTube API - API for the integration of YouTube videos
• Groq - API for the integration of Groq artificial intelligence

Project Demo Video

To take a look at the project, you can follow this link to a demo video. https://my.hidrive.com/share/iq1xjll2td

Getting Started

Prerequisites

• npm

  npm install npm@latest -g

Installation

1. Clone the Repo

   git clone https://gitlab.cs.hs-rm.de/dross001/learniverse.git

2. Navigate to Folder "learniverse"

   cd learniverse

4. Install NPM Packages

   npm install

5. Enter Your API in This File: .env.local

NEXT_PUBLIC_API_KEY = "secret";
NEXT_PUBLIC_YT_API_KEY = "secret";

6. Start the Project

   npm run dev

Folder Structure

‚
├── __mocks__
├── .next
├── .vscode
├── components
│   ├── BenefitCardBar
│   │   ├── BeneditCard
│   │   │   ├── BeneditCard.Module.css
│   │   │   ├── BeneditCard.tsx
│   │   ├── ...
│   ├── ...
├── context
├── coverage
├── interfaces
├── node_modules
├── pages
│   ├── api
│   │   ├── content.ts
│   ├── moduleDetail
│   ├── _app.tsx
│   ├── _document.tsx
│   ├── 404.module.css
│   ├── 404.tsx
│   ├── graphiverse.module.css
│   ├── graphiverse.tsx
│   ├── index.module.css
│   ├── index.tsx
├── playwright-report
├── public
│   ├── fonts
│   ├── ...
├── styles
│   ├── globals.css
├── tests
│   ├── playwright_e2e
│      ├── header.spec.ts
│      └── ...
├── unitTests
    ├── Chat.test.tsx
├── .env.local
└── ...

Tests

E2E-Tests (Playwright)

# Before all (in different terminal)
npm run dev

# Execute all tests
npx playwright test

# Execute a special test (here: “Click First Module Card”)
npx playwright test -g "Click First Module Card"

# Record your own test (at the end the url where it should start)
npx playwright codegen localhost:3000

# Execute all tests in indexTest.spec.ts
npx playwright test indexTest.spec.ts

# Open Ui to execute all tests (optional: write specific file after “test”)
npx playwright test --ui

# Execute all tests in test.spec.ts and watch (write specific file to “test” if necessary)
npx playwright test --headed

# Shows report of the last executed test (overview of what failed and why)
npx playwright show-report

Unit-Tests (Jest)

# Alle Tests ausführen
npm test

Node: In file package-lock.json a script is defined -> with "npm test" the command "npm run jest tests/jest" is executed (so playwright tests don't get tested at the same time)

Contact

Valentin Diehl - Valentin.Diehl@student.hs-rm.de
Julia Trumpp - Julia.Trumpp@student.hs-rm.de
David Rossel - David.rossel@student.hs-rm.de