En este apartado se encuentra toda la documentación relacionada con este proyecto. Actualmente este proyecto se encuentra en producción y es accesible desde Internet sin necesidad de ejecutar las siguientes tareas. Los detalles sobre la version publica en producción se encuentran en el README.md de la raíz del proyecto.
El manual de implantación se divide en dos manuales en función de los intereses de la implantación:
- Manual de desarrollo: incluye instrucciones para poder recreear de manera local el proyecto.
- Manual de despliegue: incluye instrucciones para poder deplegar la aplicacion en un entorno real de producción. Para poder efectuar este manual es necesario disponer de un entorno local la aplicación web.
Las siguientes instrucciones son útiles para poder recreear de manera local el proyecto.
| # | documento | Resumen |
|---|---|---|
| 1 | docker.md | Ejecutar el proyecto de manera local usando Docker. Esta es la manera más sencilla de lanzar el proyecto de manera local. |
| 2 | local.md | Ejecutar el proyecto de manera local usando el Host. Útil para usar un IDE y proceder con el Manual de despliegue. |
| 3 | cordova.md | Crear aplicación android de manera local |
| 4 | cicd.md | Uso de CI/CD |
NOTA 1: Para ejecutar el proyecto de manera local existen dos métodos: docker.md o local.md. Solo es necesario usar uno de ellos.
NOTA 2: Este proyecto por defecto está configurado para usar la base de datos dw-bote.firebaseio.com tal y como se especifica en los archivos de entorno
environment.prod.ts y environment.ts. El procedimiento para usar una solución
propia de Firebase se detalla en el Manual de despliegue
Las siguientes instrucciones son útiles para poder desplegar el proyecto web usando las tecnologías de Firebase (Producción). En este proceso se detallan las instrucciones a seguir para poder crear una base de datos y todos los servicios necesarios para poder desplegar el proyecto a un entorno de producción.
| # | documento | Resumen |
|---|---|---|
| 1 | firebase.md | Configurar un nuevo proyecto Firebase |
| 2 | firestore.md | Habilitar base de datos en tiempo real (Firebase Firestore) |
| 3 | authentication.md | Habilitar login/registro de usuarios (Firebase Authentication) |
| 4 | hosting.md | Habilitar el hosting (Firebase Hosting) |
| 5 | functions.md | Habilitar funciones del proyecto (Firebase Functions) |
Para poder ejecutar de manera local usando un nuevo proyecto de Firebase deberá de seguir como mínimo los pasos de despliegue números 1, 2 y 3. Prueba el nuevo proyecto de Firebase usando los pasos especificados en docker.md o local.md del Manual de desarrollo.
Las siguientes instrucciones son útiles para conocer el funcionamiento de la aplicación web. Estas referencias son válidas para la versión de navegador así como la aplicación para dispositivos móviles.
| # | documento | Resumen |
|---|---|---|
| 1 | registro.md | Registrarse en el aplicativo |
| 2 | login.md | Login en el aplicativo |
| 3 | inicio.md | Página inicio del aplicativo |
| 4 | perfil.md | Cambios en el perfil de usuario |
| 5 | resumen.md | Resumen de un viaje |
| 6 | viajes.md | Gestionar viajes |
| 7 | gastos.md | Gestionar gastos |
| 8 | pagos.md | Gestionar pagos |
| 9 | extra.md | Información adicional |
Durante el proceso final de desarrollo se ejecutaron multiples test para validar que todas las funciones y características del proyecto funcionaban.
Las pruebas realizadas se encuentran el la sección de pruebas.
Durante el desarrollo del proyecto se consultaron los siguientes recursos:
- Angular 8 y Firestore
- Cloud Scheduler API
- Integrating Google Sign-In into your web app
- How to create a signed APK file using Cordova command line interface?
- fix(android): Back button fix for SDK28
- Continuous Delivery en Android con Gitlab CI, Fabric Beta, Google Play y Fastlane.
- Abiro PhoneGap Image Generator
- Protect Your HTTP Firebase Cloud Functions
- How to create signed android apk with Apache Cordova