/codicon-05-front

Front de FundEase, un proyecto de la Hackathon YummyCodicon 2023

Primary LanguageTypeScript

FundEase

Logo Codicon

FundEase es un proyecto presentado en la Hackathon de Codicon 2023, patrocinada y organizada por Yummy, con este propuesta se busca facilitar la utilidad del sobrante en efectivo utilizado en los pagos de servicios en apps mobile para servicios de transporte, comida, etc. para que este pueda ser donado a fundaciones sin fines de lucro, simplificando el proceso de pago al prestador del servicio al evitar la gestión del vuelto entre usuario y prestador.

Contribuidores

Este proyecto fue construido por un grupo multidisciplinario de jovenes Venezolanos, siendo estos:

El talento combinado y visión de este grupo nos ha permitido mostrar nuestra visión de una propuesta viable para el mercado de mobile apps en Venezuela donde se ofrecen beneficios a Organizaciones Sin Fines de Lucro.

Demo

Puede probar una demo del proyecto aca: https://akrista.github.io/codicon-05-front/combo

demo.webm

Probar el Proyecto

Recuerde copiar el archivo .env.example a .env y configurar el endpoint asociado al backend del app.

Si posees docker instalado, puedes simplemente ejecutar el script run.sh

Puede ejecutar fácilmente el proyecto de dos maneras:

Via Docker

Se requiere tener instalado Docker y Docker Compose.

# Compilar la imagen
docker-compose build
# Correr el proyecto
docker-compose up -d --force-recreate

Via NPM / Yarn / PNPM

Se requiere tener instalado Node.js.

# Instalar dependencias
npm install
# Correr el proyecto
npm run dev
# Con Yarn
yarn install
yarn dev
# Con PNPM
pnpm install
pnpm dev

Producción

Para desplegar esta app en producción, encontrara en el archivo docker-compose.yml una sección de "labels" y un contenedor adicional llamado Traefik. Este servicio permite crear un reverse proxy http, de manera que se proteja el trafico recibido.

Para adicionar dicho servicio, asegurese de:

  1. Comentar los puertos del app
  2. Descomentar las labels, networks y el contenedor de traefik
  3. Asignar el ip de su URL Publica para el app en el label traefik.http.routers.fundease.rule=Host(`your.domain.com`)
  4. Cree una carpeta llamada "config" en el root de este repo
  5. Cree una copia del archivo traefik.yml.example en la carpeta recien creada, el archivo debe llamarse "traefik.yml"
  6. Ejecute el script run.sh