En este README se explicará cómo se puede utilizar la herramienta, así como realizar el despliegue de ambos servicios de una forma sencilla.
Para detalles más específicos de cada uno de los servicios mirar su repositorio correspondiente.
El primer paso para poder poner en marcha el proyecto es, clonar el repositorio e instalar las dependencias necesarias mediante npm.
git clone --recurse-submodule -j8 [email protected]:SalvaChiLlo/Reporting.git
cd Reporting
npm install
npm install -g ts-node
Para ejecutar la solución como una herramienta de terminal podemos ejecutar el siguiente comando.
./reporting --customers ./sample/customers.csv --products ./sample/products.csv --orders ./sample/orders.csv
En la carpeta sample se encuentran los diferentes archivos de entrada de ejemplo.
La herramienta requiere que se le pasen las opciones customers, products y orders junto con la ruta que indica la posición del archivo.
No se requiere ningún orden específico de los argumentos.
La solución también se encuentra como una aplicación web con una página web realizada con Angular, la cual, realiza peticiones al backend que expone una API que permite subir 3 archivos CSV y con estos se llama a la funcionalidad deseada. Para lanzar a ejecución tanto el servidor del frontend como el del backend, ejecuta cada comando en una ventana de terminal.
npm run serveBack
npm run serveFront
- Se debería de abrir una pestaña en el navegador con la aplicación en funcionamiento, sino, http://localhost:4200.
- Por defecto, el backend se ejecutará en el puerto
8080. Si se desea cambiar, simplemente hay que cambiar la variable de entorno del archivo.enven el directorio ReportingBackend.
Si quieres probar la herramienta pero no quieres instalar ninguna dependencia, puedes utilizar Docker.
En este docker-compose.yml encontrarás la definción de los servicios, la cual, podrás lanzar a ejecución con el comando
docker-compose up -d
Una vez lanzado, se habrán creado dos contenedores, uno para el frontend y otro para el backend. Con la configuración por defecto, podrás acceder a la aplicación web a través de http://localhost.