Commit e796bac9 authored by Curtis Adam's avatar Curtis Adam

Translated the contributing guide into english

parent 5179a472
Pipeline #35054 passed with stage
in 5 minutes and 40 seconds
# Contribution Guide
Dieses Dokument erläutert, wie an der Anwendung mitgearbeitet, oder diese weitergeführt werden kann. Zum Testen des Funktionsumfanges sollte eine lokale Testumgebung mit Back- und Frontend eingerichtet werden.
This document explains how the application can be collaborated on or continued. To test the scope of functions, you should set up a local test environment with a backend and a frontend.
## Einrichten einer Testumgebung
## Setting Up a Test Environment
Im folgenden wird erklärt, wie man das Backend aufsetzt und das Frontend damit testen kann.
The following section explains how to set up the backend and test the frontend with it.
### Software
#### Frontend
......@@ -12,14 +12,14 @@ Im folgenden wird erklärt, wie man das Backend aufsetzt und das Frontend damit
* Angular CLI 1.7.4
#### Backend
* Java JDK 8 (neuere Versionen funktionieren NICHT)
* Maven 3.5.4 (neuere Versionen funktionieren NICHT)
* Java JDK 8 (newer versions do NOT work)
* Maven 3.5.4 (newer versions do NOT work)
#### Optional
*Testen in einer virtuellen Maschine*
*Testing in a virtual machine*
* Vagrant
### Einrichtung des Backends
### Setting up the back end
```bash
git clone git@git.thm.de:mocainfo/backend.git
......@@ -29,14 +29,14 @@ mvn clean package
java -jar target/backend-1.0-SNAPSHOT.jar
```
**Hinweise:**
**Notes:**
1. Zur Zeit ist die Authentifizierung per Frontend nur möglich im `production`-Branch des Backends.
1. Das Backend startet mit einer In-Memory Datenbank und verliert daher nach dem Beenden alle Daten.
1. Die Datenbank enthält beim Starten einige Standarddaten.
1. At the moment authentication via frontend is only possible in the `production` branch of the backend.
1. The backend starts with an in-memory database and therefore loses all data after it has been closed.
1. The database contains some standard data at startup.
#### Einrichten des Frontends
#### Setting up the front end
```bash
git clone git@git.thm.de:mocainfo/web-app-v3.git
......@@ -44,11 +44,11 @@ cd web-app-v3
npm install
npm run start
```
**Anwendung konfigurieren:**
**Configure application:**
1. Anwendung aufrufen per [http://localhost:4200](http://localhost:4200)
1. Wähle das "CMS localhost" Backend, oben rechts in der Navigationsleiste, aus.
1. Einloggen per `mike` und `topsecret`.
1. Call application using [http://localhost:4200](http://localhost:4200)
1. Select the "CMS localhost" backend, top right in the navigation bar.
1.Log in via username `mike` and password `topsecret`.
## Build
......@@ -56,25 +56,25 @@ npm run start
npm run build
```
Unter `dist` ist die statische Anwendung zu finden, welche per Webserver (bsw. Apache) ausgeliefert werden kann.
The static application can be found under `dist`, which can be delivered via a web server (for example Apache).
## Code-Dokumentation mit Compodoc
## Code documentation with Compodoc
```bash
npm run compodoc
```
Die Dokumentation ist daraufhin unter `documentation` zu finden.
The documentation can then be found under `documentation`.
## Statische Tests
## Static Tests
### Unit Tests mit Coverage
### Unit Tests with Coverage
```bash
npm run test
```
Ein Coverage Report wird unter `coverage` abgelegt.
A Coverage Report is stored under `coverage`.
### End to End Tests
......@@ -82,24 +82,24 @@ Ein Coverage Report wird unter `coverage` abgelegt.
npm run e2e
```
### Codeanalyse mit TSLint und SonarTS
### Code analysis with TSLint and SonarTS
```bash
npm run lint
```
## Testen unter Vagrant
## Testing under Vagrant
```bash
vagrant up
vagrant ssh
```
Innerhalb der Vagrant Box:
Inside the Vagrant Box:
```bash
cd web-app-v3
npm install
```
Nun können die bereits dargestellten Kommandos zum Testen genutzt werden.
Now the commands already displayed can be used for testing.
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment