Skip to content

Commit

Permalink
Mejoras en el readme
Browse files Browse the repository at this point in the history
Mejoras en el readme
  • Loading branch information
olodum7 authored Dec 7, 2023
2 parents 542121c + 19a710e commit d83ffa4
Show file tree
Hide file tree
Showing 2 changed files with 27 additions and 4 deletions.
Binary file modified Front/public/viajecito-logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
31 changes: 27 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
![Página de Inicio](/Front/public/viajecito-logo.png)
![logo](/Front/public/viajecito-logo.png)

# Viajecito 🌎✈️

_Tu aventura empieza hoy. Encuentra y reserva tours y experiencias únicas. Un proyecto del primer track de Certified Tech Developer._
🌍 _Un Proyecto Integrador de Certified Tech Developer, una iniciativa educativa co-creada por Digital House, Mercado Libre y Globant._

## Descripción

Expand All @@ -16,6 +14,12 @@ Viajecito permite a los viajeros explorar y reservar tours que capturan la esenc
- **Almacenamiento**: AWS S3 para imágenes y contenido estático.
- **Despliegue**: GitHub Actions con runners en AWS EC2.

## Documentación de la API 📄

Consulta la documentación completa y prueba los endpoints de la API a través de Swagger UI:

[Swagger UI](http://34.207.134.182:8089/swagger-ui/index.html)

## Instalación 🚀

```bash
Expand All @@ -37,8 +41,27 @@ Navega a través de una variedad de categorías y descubre tours que se alinean

## Infraestructura 🌐

El proceso de CI/CD de Viajecito está automatizado con GitHub Actions y aprovecha la robusta infraestructura de AWS.

- **GitHub Actions**: Al realizar un push al branch principal, se activan los workflows definidos para el despliegue automático del backend y el frontend.
- `build-backend`: Construye la imagen de Docker del backend a partir del `Dockerfile`, y luego la sube a Docker Hub.
- `build-frontend`: Ejecuta `npm run build` para preparar el build de producción y lo despliega en un bucket S3 destinado al hosting del frontend.
- `deploy-backend`: Toma la imagen del backend de Docker Hub y la despliega en un contenedor de Docker que se ejecuta en una instancia de Amazon EC2 dedicada a la API.

- **AWS S3**: Se utilizan dos buckets de S3:
- Un bucket para alojar el build del frontend y servir el contenido estático a los usuarios.
- Otro bucket para almacenar las imágenes que son cargadas en los tours, las cuales son referenciadas en la base de datos.

- **Amazon EC2**: Se emplean dos instancias de EC2:
- Una para ejecutar el contenedor de Docker que aloja la base de datos MySQL, aislada dentro de una VPC para seguridad adicional.
- Otra para ejecutar el contenedor de Docker que aloja la API del backend.

- **MySQL**: La base de datos corre en su propio contenedor en una de las instancias EC2 y almacena toda la información necesaria para el funcionamiento de Viajecito, incluyendo los datos de los tours y reservas.

![Diagrama de Infraestructura](/Front/public/viajecito-diagrama-infraestructura.png)

Esta infraestructura está diseñada para asegurar la escalabilidad, la eficiencia y la seguridad en el despliegue.

## Colaboradores 🤝

- Camila Fortunato
Expand Down

0 comments on commit d83ffa4

Please sign in to comment.