Skip to content

Eine Schule hinzufügen

Alessio Caputo edited this page Apr 28, 2024 · 3 revisions

Voraussetzungen: Stelle sicher, dass Node.js und npm auf deinem System installiert sind.

Schritte zum Mitwirken:

  1. Fork erstellen: Gehe auf GitHub und erstelle einen Fork dieses Projekts. image

  2. Fork klonen: Nutze einen Git-Client wie GitHub Desktop, um die Repository auf deinen Computer zu kopieren.

  3. Neuen Branch erstellen: Benenne den Branch "add-school-{schulnummer}". image

  4. Projekt im Editor öffnen: Öffne das Projekt in deinem bevorzugten Editor (bsp. VScode oder WebStorm). image

  5. in die richtige directory wechseln

    cd lanis-mobile-api
    
  6. Notwendige Module installieren: Führe den Befehl npm install aus.

  7. Projekt ausführen: Starte das Projekt mit dem Befehl npm run dev. In der Konsole siehst du eine URL, auf der die API automatisch bei code-änderungen aktualisiert wird.

  8. Schule hinzufügen: Bearbeite die Datei src/endpoints/filterGenerate.ts. Deine Änderungen werden sofort übernommen. Teste die API am besten mit einem REST client wie Insomnia oder direkt über das SwaggerUI im Browser.

  9. Änderungen committen: Commite deine Änderungen entweder direkt im Editor oder über GitHub Desktop und pushe sie anschließend.

  10. Pull Request erstellen: Erstelle eine Pull Request von deinem Fork zur ursprünglichen Repository über die GitHub-Website.

Clone this wiki locally