61 lines
2.1 KiB
Markdown
61 lines
2.1 KiB
Markdown
# Praxistransferprojekt II (ptpChat) - Frontend
|
|
|
|
Dieses Repository beinhaltet das Frontend für das im zweiten Semester realisierte Projekt "ptpChat"
|
|
|
|
> **_Notiz:_** Die folgende Anleitung erlaubt ein Setup des Frontends komplett ohne IDE. Durch die Verwendung einer solchen entfallen manche Schritte gegebenenfalls.
|
|
|
|
## Voraussetzungen
|
|
Vor der Durchführung der anderen Schritte sollte sichergestellt werden, dass die folgenden Softwarekomponenten installiert sind. Grundsätzlich kann, je nach persönlicher Präferenz, zwischen `npm` und `yarn` ausgewählt werden:
|
|
|
|
- [Node.js](https://nodejs.org/)
|
|
- [Yarn](https://yarnpkg.com/) oder [npm](https://www.npmjs.com/)
|
|
|
|
(In der Entwicklung wurde ausschließlich npm verwendet, was aus diesem Grund hier empfohlen wird)
|
|
|
|
Außerdem wird `git` benötigt:
|
|
|
|
- [git Donwloads](https://git-scm.com/downloads)
|
|
|
|
## Clonen des Repositories
|
|
Zum Clonen des Repositories muss folgender Befehl in einer beliebigen Shell ausgeführt werden:
|
|
|
|
```bash
|
|
git clone https://github.com/joschuatonn/praxistransferFrontend
|
|
```
|
|
|
|
Für die folgenden Schritte muss zuerst in das Projektverzeichnis navigiert werden:
|
|
|
|
```bash
|
|
cd praxistransferFrontend
|
|
```
|
|
|
|
## Installieren der Dependencies
|
|
```bash
|
|
yarn
|
|
# oder
|
|
npm install
|
|
```
|
|
|
|
## Starten der Applikation im Development-Modus
|
|
```bash
|
|
yarn dev
|
|
# oder
|
|
npm run dev
|
|
```
|
|
|
|
Sofern die Quasar-CLI installiert ist, kann auch folgender Befehl verwendet werden:
|
|
|
|
```bash
|
|
quasar dev
|
|
```
|
|
|
|
### Nutzung der Applikation
|
|
|
|
Das Setup des Frontends ist nun abgeschlossen. Standardmäßig ist dieses über `http://localhost:8080` erreichbar. Um die reibungslose Funktionalität der gesamten Applikation zu gewährleisten, wird von einer Änderung der Standardeinstellung abgeraten.
|
|
|
|
Um die Installation der Applikation vollständig abzuschließen, müssen außerdem die Anleitungen in folgenden Repos befolgt werden:
|
|
|
|
[ptpChat-Services](https://github.com/joschuatonn/praxistransferServices) --> Enthält die Installation von Keycloak und Postgres
|
|
|
|
[ptpChat-Backend](https://github.com/joschuatonn/praxistransferBackend) --> Enthält das Java-SpringBoot Backend
|