Du kannst mithelfen, die Youthweb-API zu gestalten, indem du an diesem Projekt mitarbeitest. Du kannst Fehler melden, Features vorschlagen oder bei der Dokumentation helfen. Wenn die geplante API auf dem Live-Server von Youthweb umgesetzt ist, bekommt die API einen neuen Tag.
API
Um Bugs oder Features zu testen, solltest du die Änderungen lokal testet. Dazu benötigst du PHP >= 7.4 und Node.js 10 mit npm.
Installation
1.) Forke dieses Projekt in deinen eigenen Account.
2.) Clone das Projekt mit git clone git@gitlab.com::<username>/youthweb-api.git und wechsle in das neue Verzeichnis.
3.) Installiere Composer und alle Abhänigkeiten:
curl http://getcomposer.org/installer | php
php composer.phar install
4.) Installiere die npm-Abhängigkeiten und starte den Mock-Server:
npm install
npm run server
Der Mock-Server muss während der Tests im Hintergrund laufen. Starte ihn daher am besten in einem eigenen Terminal.
5.) Teste deine API mit npm test. Wenn die Tests erfolgreich durchlaufen, dann ist alles richtig installiert.
Änderungen
Du kannst jetzt deine gewünschten Änderungen im API-Blueprint durchführen und diese mit einem Behat-Feature absichern. Vergiss nicht, deine Änderungen zu testen:
npm test
Anschließend kannst du deine Änderungen mit einem Pull-Request einreichen.
Dokumentation
Die Dokumentation befindet sich im Order /docs und wird dank der Gitlab-Pages automatisch deployed. Wenn du Fehler korrigieren oder Ergänzugen einreichen möchtest, dann freuen wir uns auf deinen Pull-Request.
Bearbeiten