diff --git a/src/introduction.md b/src/introduction.md index aec01c4..0a03ddb 100644 --- a/src/introduction.md +++ b/src/introduction.md @@ -1,28 +1,30 @@ -# Introduction +# Introducción -Contigo Burrito is a project that aims to achieve real-time tracking of the UNMMS internal -transport bus (*or buses!*) to make students' lives easier, as well as: +Contigo Burrito es un proyecto que busca lograr el seguimiento en tiempo real +del autobús (¡o autobuses!) de transporte interno de la UNMSM para facilitar +la vida de los estudiantes. Además, incluye las siguientes características: -- In-app notifications in the form of banners, popups and posts. -- Real-time tracking of the bus location, status and device battery. -- App versioning and forcing client updates. -- Bus stops and route information, including the distance to the next stop. -- User sessions (for analytics) and authentication (for protected resources). -- Feature flags for both server and clients. -- Multimedia upload integration with [Cloudinary](https://cloudinary.com/). +- Notificaciones en la aplicación en forma de banners, ventanas emergentes y publicaciones. +- Seguimiento en tiempo real de la ubicación del autobús, su estado y el nivel + de batería del dispositivo. +- Versionado de la aplicación y forzar actualizaciones en los clientes. +- Información de paradas y rutas, incluyendo la distancia a la próxima parada. +- Sesiones de usuario (para analíticas) y autenticación (para recursos protegidos). +- Flags de características tanto para el servidor como para los clientes. +- Integración para subir multimedia con [Cloudinary](https://cloudinary.com/). -The following document contains all the technical high-level documentation of the project, -including development setup, compilation, distribution, deployment, and other relevant -information. +El siguiente documento contiene toda la documentación técnica de alto nivel +del proyecto, incluyendo la configuración de desarrollo, compilación, +distribución, despliegue y otra información relevante. -## Support and Contact +## Soporte y Contacto -Feel free to reach out to the team if you have any questions or need help with the project: +No dudes en contactar al equipo si tienes preguntas o necesitas ayuda con el proyecto: - Paolo Flores [@paoloose](https://github.com/paoloose), -[pflores.fisi22@gmail.com](mailto:paolo.flores2@unmsm.edu.pe) + [pflores.fisi22@gmail.com](mailto:paolo.flores2@unmsm.edu.pe) - Luis Calle [@luedu1103](https://github.com/luedu1103) diff --git a/src/overview.md b/src/overview.md index 69c0fc0..72563af 100644 --- a/src/overview.md +++ b/src/overview.md @@ -1,52 +1,55 @@ -# Overview +# Resumen -Here is a brief overview of the Contigo Burrito project and how its components -interact with each other. For more detailed information, refer to the specific -documentation of each component. +A continuación, se presenta una descripción general del proyecto Contigo Burrito y cómo +sus componentes interactúan entre sí. Para información más detallada, consulta la +documentación específica de cada componente. -## Components +## Componentes -The project is divided into four main components, each with its own repository:s +El proyecto está dividido en cuatro componentes principales, cada uno con su propio +repositorio: - - - + + + - + - + - + - +
RepositoryDescriptionTechnologiesRepositorioDescripciónTecnologías
burrito-appThe app that students use to check the bus status.La app que los estudiantes usan para verificar el estado del autobús. Flutter, Riverpod, Google Maps
burrito-serverREST API server responsibleServidor REST API responsable. Rust, Rocket
burrito-driverBus driver app that sends the location data.Aplicación para el conductor del autobús que envía datos de ubicación. Flutter, Geolocator
burrito-dashboardAdmin dashboard to interact with the system.Panel de administración para interactuar con el sistema. Vite, React
-Note that these are private repositores, so you may need to request access to them. +Ten en cuenta que estos son repositorios privados, por lo que es posible que +necesites solicitar acceso a ellos. -## Architecture +## Arquitectura -The project follows a client-server architecture, where the server and driver are responsible for -managing the data and the clients are responsible for displaying it. +El proyecto sigue una arquitectura cliente-servidor, donde el servidor y la aplicación +del conductor son responsables de gestionar los datos y los clientes se encargan +de mostrarlos. -![Project architecture](./assets/architecture_diagram.png) +![Arquitectura del proyecto](./assets/architecture_diagram.png)