issue wanted

Problème recherché

issue-wanted est une application Web axée sur l'amélioration de la communauté Haskell open source en centralisant les problèmes de GitHub dans de nombreux référentiels Haskell en un seul emplacement. Les objectifs de issue-wanted sont de faciliter la recherche de projets Haskell aux programmes pour trouver plus facilement le nombre de contributions aux projets open source Haskell et d'encourager davantage de programmeurs à faire partie de la communauté Haskell.

Description de l'architecture

Les principaux travaux sur ce projet ont été réalisés pendant Google Summer of Code 2019. Pour toute personne intéressée par les détails de la mise en œuvre de la mise en œuvre issue-wanted et de la raison pour laquelle certains choix de conception ont été faits, consultez ces articles de blog:

• GSOC 2019 - Construire une application Web avec Haskell
• Guide de la mise en œuvre des effets monadiques personnalisés dans les problèmes
• GSOC 2019 - Évaluation finale

Backend

Prérequis (ce que vous avez besoin d'avoir localement)

Vous devrez installer les installations suivantes sur votre système afin de construire et de tester issue-wanted . Cliquez sur les liens pour apprendre à installer chacun:

1. GHC
2. cabale ou pile
3. docker
4. libpq-dev : Exécutez la commande sudo apt install libpq-dev pour installer.

Avec docker installé, ouvrez un terminal (assurez-vous que vous êtes dans le répertoire issue-wanted ) et exécutez la commande make postgres . Cela configurera la base de données pour vous et vous devriez être prêt à partir!

Suivez les instructions sous How to run server et tester les points de terminaison pour voir si tout est configuré correctement.

Reportez-vous au numéro 81 si vous avez toujours des problèmes.

Comment construire

Pour construire le projet, ouvrez un terminal dans le dossier de base et exécutez

stack build

ou

cabal v2-build

Comment générer des types d'orme

Si des types sont modifiés, il faut mettre à jour les types générés en Elm en fonctionnant:

stack run generate-elm

ou

cabal v2-run generate-elm

Comment exécuter le serveur

Pour tester le serveur issue-wanted suivez ces étapes:

1. Ouvrez le terminal dans le dossier de base et exécutez stack build
2. Exécutez le stack exec issue-wanted commande

Le serveur commencera à fonctionner sur http://localhost:8080/ .

API

Points de terminaison artisanaux disponibles:

Point final	Description
/issues	Renvoie tous les problèmes.
/issues/:id	Renvoie un seul problème avec l'ID correspondant.
/issues?label=<label name>	Renvoie une liste de problèmes avec l'étiquette correspondante.

Conseil: si vous arrêtez d'exécuter le serveur et essayez ensuite de le redémarrer, vous devrez peut-être exécuter le fuser -n tcp -k 8080 pour libérer le port.

Comment exécuter les tests automatiques localement

1. Dans un terminal séparé, make postgres (cette commande exécutera la base de données dans un conteneur docker)
2. Dans le premier stack test run ou cabal new-test

Comment déployer une nouvelle image docker pour CI

Lorsque stack Snapshot est mis à jour, vous devez mettre à jour Dockerfile en conséquence et pousser une nouvelle image Docker sur Docker Hub. Cela ne peut être fait que si vous avez accès aux informations d'identification du compte.

Effectuez les commandes suivantes:

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

L'extrémité avant

Actuellement, Frontend est implémenté à l'aide de Elm .

Prérequis (ce que vous avez besoin d'avoir localement)

• elm
• npm
• create-elm-app : Pour installer Run npm install -g [email protected]

Comment courir

Remarque: Toutes les actions doivent être effectuées dans le dossier frontend :

 cd frontend/

Première fois

• Obtenez des modules de nœud: npm install
• Procéder à des étapes suivantes

Ultérieur

• Dans un onglet: elm-app start
• Dans un autre onglet: npm run-script watch-css

Frontend commencera à fonctionner sur http://localhost:3000/ .