From 65562174a61933176b78900219d1d056fe58b0c4 Mon Sep 17 00:00:00 2001 From: Paolo Flores Date: Sat, 4 Jan 2025 11:26:58 -0500 Subject: [PATCH] Revert "translate to spanish" This reverts commit 8dad5f03bb7e34105a53c5fb5bb44b8cf60ac5c0. --- src/introduction.md | 34 ++++++++++++++++------------------ src/overview.md | 39 ++++++++++++++++++--------------------- 2 files changed, 34 insertions(+), 39 deletions(-) diff --git a/src/introduction.md b/src/introduction.md index 0a03ddb..aec01c4 100644 --- a/src/introduction.md +++ b/src/introduction.md @@ -1,30 +1,28 @@ -# Introducción +# Introduction -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: +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: -- 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/). +- 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/). -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. +The following document contains all the technical high-level documentation of the project, +including development setup, compilation, distribution, deployment, and other relevant +information. -## Soporte y Contacto +## Support and Contact -No dudes en contactar al equipo si tienes preguntas o necesitas ayuda con el proyecto: +Feel free to reach out to the team if you have any questions or need help with the project: - 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 72563af..69c0fc0 100644 --- a/src/overview.md +++ b/src/overview.md @@ -1,55 +1,52 @@ -# Resumen +# Overview -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. +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. -## Componentes +## Components -El proyecto está dividido en cuatro componentes principales, cada uno con su propio -repositorio: +The project is divided into four main components, each with its own repository:s - - - + + + - + - + - + - +
RepositorioDescripciónTecnologíasRepositoryDescriptionTechnologies
burrito-appLa app que los estudiantes usan para verificar el estado del autobús.The app that students use to check the bus status. Flutter, Riverpod, Google Maps
burrito-serverServidor REST API responsable.REST API server responsible Rust, Rocket
burrito-driverAplicación para el conductor del autobús que envía datos de ubicación.Bus driver app that sends the location data. Flutter, Geolocator
burrito-dashboardPanel de administración para interactuar con el sistema.Admin dashboard to interact with the system. Vite, React
-Ten en cuenta que estos son repositorios privados, por lo que es posible que -necesites solicitar acceso a ellos. +Note that these are private repositores, so you may need to request access to them. -## Arquitectura +## Architecture -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. +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. -![Arquitectura del proyecto](./assets/architecture_diagram.png) +![Project architecture](./assets/architecture_diagram.png)