issue wanted

Ausgabe gesucht

issue-wanted ist eine Webanwendung, die sich auf die Verbesserung der Open-Source-Haskell-Community konzentriert, indem Github-Probleme in vielen Haskell-Repositories an einem einzigen Standort zentralisiert werden. Die Ziele von issue-wanted sind es, den Programmierern aller Fähigkeiten zu erleichtern, Haskell-Projekte zu finden, um dazu beizutragen, die Anzahl der Beiträge zu Open-Source-Haskell-Projekten zu erhöhen und mehr Programmierer zu ermutigen, Teil der Haskell-Community zu werden.

Architekturbeschreibung

Die Hauptarbeiten an diesem Projekt wurden während des Google Summer of Code 2019 durchgeführt. Für alle, die sich für die Einzelheiten der implementierten issue-wanted interessieren und warum bestimmte Designentscheidungen getroffen wurden, lesen Sie die folgenden Blog-Beiträge:

• GSOC 2019 - Erstellen einer Webanwendung mit Haskell
• Leitfaden für die Implementierung benutzerdefinierter monadischer Effekte in problematischen Wants
• GSOC 2019 - endgültige Bewertung

Backend

Voraussetzungen (was Sie vor Ort haben müssen)

Sie müssen Folgendes auf Ihrem System installieren lassen, um issue-wanted zu erstellen und zu testen. Klicken Sie auf die Links, um zu erfahren, wie Sie jeweils installieren:

1. GHC
2. Kabale oder Stapel
3. Docker
4. libpq-dev : Führen Sie den Befehl sudo apt install libpq-dev um zu installieren.

Öffnen Sie mit installiertem docker ein Terminal (stellen Sie sicher, dass Sie in dem issue-wanted ) und führen Sie den Befehl make postgres . Dadurch wird die Datenbank für Sie eingerichtet und Sie sollten bereit sein zu gehen!

Befolgen Sie die Anweisungen, How to run server und testen Sie die Endpunkte, um festzustellen, ob alles richtig eingerichtet ist.

Siehe Ausgabe Nr. 81, wenn Sie immer noch Probleme haben.

Wie man baut

Öffnen Sie zum Erstellen des Projekts ein Terminal im Basisordner und laufen Sie aus

stack build

oder

cabal v2-build

So generieren Sie ELM -Typen

Wenn irgendwelche Typen geändert werden, sollten Sie die generierten ELM -Typen durch Ausführen aktualisieren:

stack run generate-elm

oder

cabal v2-run generate-elm

So führen Sie Server aus

Für das Testen des issue-wanted befolgen Sie die folgenden Schritte:

1. Öffnen Sie das Terminal im Basisordner und führen Sie stack build aus
2. Führen Sie den stack exec issue-wanted

Der Server wird unter http://localhost:8080/ ausgeführt.

API

Ausgreifende verfügbare Endpunkte verfügbar:

Endpunkt	Beschreibung
/issues	Gibt alle Probleme zurück.
/issues/:id	Gibt ein einzelnes Problem mit der entsprechenden ID zurück.
/issues?label=<label name>	Gibt eine Liste von Problemen mit dem entsprechenden Etikett zurück.

Tipp: Wenn Sie den Server nicht mehr ausführen und dann versuchen, ihn neu zu starten, müssen Sie möglicherweise den Befehl fuser -n tcp -k 8080 ausführen, um den Port zu befreien.

So führen Sie automatische Tests lokal aus

1. make postgres (in diesem Befehl wird die Datenbank in einem Docker -Container ausgeführt).
2. Im ersten Terminal Run stack test oder cabal new-test

So bereitstellen Sie ein neues Docker -Image für CI

Wenn stack Snapshot aktualisiert wird, müssen Sie Dockerfile entsprechend aktualisieren und ein neues Docker -Image auf Docker Hub weitergeben. Dies kann nur dann erfolgen, wenn Sie Zugriff auf die Kontoanmeldeinformationen haben.

Führen Sie die folgenden Befehle aus:

 docker build . -t kowainik/haskell-ci
docker push kowainik/haskell-ci

Frontend

Derzeit wird Frontend mit Elm implementiert.

Voraussetzungen (was Sie vor Ort haben müssen)

• elm
• npm
• create-elm-app : So npm install -g [email protected]

Wie man rennt

Hinweis: Alle Aktionen sollten im frontend -Ordner ausgeführt werden:

 cd frontend/

Erstmals

• Holen Sie sich Knotenmodule: npm install
• Fahren Sie mit den folgenden Schritten fort

Nachfolgend

• In einer Registerkarte: elm-app start
• In einer anderen Registerkarte: npm run-script watch-css

Frontend läuft unter http://localhost:3000/ .