issue wanted

Se busca

issue-wanted es una aplicación web centrada en mejorar la comunidad Haskell de código abierto al centralizar los problemas de GitHub en muchos repositorios de Haskell en una sola ubicación. Los objetivos de issue-wanted son facilitar que los programadores de todos los niveles de habilidad encuentren los proyectos de Haskell para contribuir, aumentar la cantidad de contribuciones a los proyectos de Haskell de código abierto y alentar a más programadores a formar parte de la comunidad de Haskell.

Descripción de la arquitectura

El trabajo principal en este proyecto se realizó durante Google Summer of Code 2019. Para cualquier persona interesada en los detalles de cómo se implementó issue-wanted y por qué se hicieron ciertas opciones de diseño, consulte estas publicaciones de blog:

• GSOC 2019 - Creación de una aplicación web con Haskell
• Guía para implementar efectos monádicos personalizados en el problema Wanted
• GSOC 2019 - Evaluación final

Backend

Prerrequisitos (lo que necesita tener localmente)

Deberá tener lo siguiente instalado en su sistema para construir y probar issue-wanted . Haga clic en los enlaces para aprender a instalar cada uno:

1. GHC
2. camarilla o pila
3. estibador
4. libpq-dev : ejecute el comando sudo apt install libpq-dev para instalar.

Con docker instalado, abra un terminal (asegúrese de que su directorio en el issue-wanted ) y ejecute el comando make postgres . ¡Esto configurará la base de datos para usted y debería estar listo para comenzar!

Siga las instrucciones bajo How to run server y probar los puntos finales para ver si todo está configurado correctamente.

Consulte el problema #81 si todavía tiene problemas.

Cómo construir

Para construir el proyecto, abra una terminal en la carpeta base y ejecute

stack build

o

cabal v2-build

Cómo generar tipos de olmo

Si se cambia los tipos, se debe actualizar los tipos generados en ELM ejecutando:

stack run generate-elm

o

cabal v2-run generate-elm

Cómo ejecutar el servidor

Para probar el servidor issue-wanted siga estos pasos:

1. Abra el terminal en la carpeta base y ejecute stack build
2. Ejecute el comando stack exec issue-wanted

El servidor comenzará a ejecutarse en http://localhost:8080/ .

API

Puntos finales con problemas disponibles:

Punto final	Descripción
/issues	Devuelve todos los problemas.
/issues/:id	Devuelve un solo problema con la identificación correspondiente.
/issues?label=<label name>	Devuelve una lista de problemas con la etiqueta correspondiente.

Consejo: si deja de ejecutar el servidor y luego intenta reiniciarlo, es posible que deba ejecutar el comando fuser -n tcp -k 8080 para liberar el puerto.

Cómo ejecutar pruebas automáticas localmente

1. En una ejecución de terminal separada, make postgres (este comando se ejecutará la base de datos en un contenedor Docker)
2. En la primera stack test de ejecución de terminal o cabal new-test

Cómo implementar una nueva imagen de Docker para CI

Cuando se actualiza la instantánea stack , debe actualizar Dockerfile en consecuencia y empujar la nueva imagen de Docker a Docker Hub. Esto solo se puede hacer si tiene acceso a las credenciales de la cuenta.

Realice los siguientes comandos:

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

Interfaz

Actualmente, Frontend se implementa utilizando Elm .

Prerrequisitos (lo que necesita tener localmente)

• elm
• npm
• create-elm-app : para instalar ejecutar npm install -g [email protected]

Cómo correr

Nota: Todas las acciones deben realizarse en la carpeta frontend :

 cd frontend/

Primer tiempo

• Obtener módulos de nodo: npm install
• Proceder a los pasos posteriores

Posterior

• En una pestaña: elm-app start
• En otra pestaña: npm run-script watch-css

Frontend comenzará a funcionar en http://localhost:3000/ .