Erstellung einer README

[ollilinde]

Story: Als interessierter Entwickler möchte ich über ein README im Project-Root darüber aufgeklärt werden, wie ich aktiv am Projekt entwickeln kann.

Akzeptanzkriterien:

1. Die genutzten Technologien sind erklärt
2. Das Setup der Entwicklungssysteme wird erklärt
3. Wie fasse ich einen Issue an und wie sieht der Git Workflow aus?

[floriangoetting]

Notizen von mir, wie ich das Frontend und die API unter Windows zum laufen bekommen habe:

1. Das Git Repository pullen

2. Docker installieren

3. In Visual Studio Code den Projektordner laden und die Docker Erweiterung für Visual Studio Code installieren

4. Node JS Installieren

5. Angular CLI (https://cli.angular.io/) installieren und Frontend Readme abarbeiten -> Frontend sollte sich nun über localhost:4200 im Browser anzeigen lassen können

6. Nest CLI (https://github.com/nestjs/nest-cli) installieren

7. Mysql Docker installieren mit docker run -d --name=mysql -e MYSQL_DATABASE=kneipenliga -e MYSQL_ROOT_PASSWORD=root -e MYSQL_ROOT_HOST=% -p 3306:3306 -d mysql:5.7

8. ormconfig.json anpassen:
   {
   "type": "mysql",
   "host": "0.0.0.0",
   "port": 3306,
   "username": "root",
   "password": "root",
   "database": "kneipenliga",
   "logging": "all",
   "logger": "advanced-console",
   "entities": ["src//.entity{.ts,.js}"],
   "synchronize": true
   }

9. API Readme abarbeiten

10. Phpmyadmin Docker installieren: docker run -d --name myadmin -e PMA_HOST=172.17.0.1 -p 8080:80 phpmyadmin/phpmyadmin -> jetzt kann die datenbank über localhost:8080 mit username root und passwort root angesehen werden

[ollilinde]

Vorschlag meinerseits:

Benötigte Software

• Angular CLI
• NestJS CLI
• Lokaler MySQL Server mit einer Datenbank kneipenliga

Setup

git clone https://github.com/ollilinde/kneipenliga-ol.git

Angular Frontend

cd kneipenliga-ol/src/frontend
npm install

NestJS API

cd kneipenliga-ol/src/api
npm install

/src/api/ormconfig.json an die Daten des lokalen MySQL-Servers anpassen

Starten der Anwendungen

Frontend

cd src/frontend && ng serve

Backend

cd src/api && npm run start