Skip to content

liip/traineesdays-image-app-exercise

Repository files navigation

Schnuppertag Bilder

Dieses Repository wird für Schnuppertage gebraucht.

Bearbeitung

Nach dem klonen sieht man nichts ausser diese markdown Datei, die TASKS.md Datei, das index.html und den src Ordner.

Mit dem Command

npm run liip-dev:toggle

Kann man alle files sichtbar machen. Es benennt das settings.json im .vscode Ordner um, damit es keinen bzw. einen Effekt hat. Es blendet, wenn aktiv, alle files ausser die oben genannten aus.

Development

Wenn man etwas bei den Aufgaben abändern will kann man folgenden command im root des Projekts ausführen.

npm run liip-dev

Commits

Man sollte immer sicherstellen, dass man das settings.json nicht inaktiv lässt und so committed.

Aufgaben

Die Aufgaben für die Schnupperlehrlinge sind im TASKS.md.

Abändern

Falls die Aufgaben verändert werden kann man mit

npm run tasks:build

die Aufgaben neu zu HTML konvertieren.

Hierzu brauchst du jedoch pandoc welches du hier installieren kannst.

Im Browser Anschauen

Die Aufgaben können im Browser angeschaut werden in dem man folgenden Command ausführt.

npm run tasks

Frontend

Das Frontend für die Aufgaben liegt im tasks folder und basiert auf svelte. Es benutzt highlight.js um codeblöcke zu highlighten.

Chat

Der Chat benutzt OpenAIs gpt-4-turbo und bekommt die Aufgaben, einschlisslich dessen Lösungen, und das Ausgangsfile eingespeist.

Dieser Chat wird den Schnupperlehrlingen automatisch zur Verfügung gestellt und sie können ihn benutzten.

Schnupperlehrlinge

Das Projekt sollte per vscode.dev ausgeführt werden in einem github codespace. Diese sind bis zu 60 Stunden auf 2 Kernen gratis und brauchen lediglich einen Github Account. Diese Accounts sollten im Voraus erstellt werden um sicher zu gehen, dass alle einen Account haben und keine Zeit verschwendet wird mit Account-Erstellung.

Auf vscode.dev ist die Github Codespaces Extension schon vorinstalliert. Sie müssen sich lediglich mit dem Github Account anmelden und das Repository auswählen.

Vor dem starten

Es muss bei jedem Lernenden ein env.js existieren, dies sollte vor dem Schnuppertag als vorbereitung passieren.

export const OPENAI_API_KEY = "key";
export const OPENAI_ORGANIZATION = "org";

Den API key für openai findet man hier und die organization hier.

Starten des Projekts

Das Projekt und die Aufgaben werden mit folgendem command ausgeführt.

npm start

Hierbei ist zu beachten, dass es drei neue tabs im browser direkt öffnet.

Durchführung

Bei der Durchführung ist zu beachten, dass zuerst eine Einführung in HTML, CSS & JavaScript gemacht werden muss bevor die Einführung in Svelte und OpenAI/ChatGPT gemacht werden kann.