mroncatto/voluntarios-backend

Red de Voluntarios

Creación de actividades de organizaciones en busca de voluntarios
Explore the docs »

View Demo · Report Bug · Request Feature

Tabla de contenido

1. Sobre el proyecto
2. Empezando
   • Requisitos
   • Instalación
3. Uso
4. Licencia

Sobre el proyecto

Plataforma para organizaciones registrar actividades donde voluntarios realizaran subscripciones en dichas actividades.

Cuenta con las siguientes funcionalidades:

- Registro de voluntarios y organizaciones
- Registro actividades
- Subscripción de actividades que se desea voluntariar

Empezando

Para ejecutar la API siga las siguientes etapas...

Requisitos

• IntelliJ IDEA o Eclipse IDE
• Java 14
• PostgreSQL en ejeccución
• Declarar las siguientes variables de ambiente:

  APP_DB_URL="DATABASE_URL:PORT" // Ejemplo: localhost:5432
  APP_DB_NAME="DATABASE_NAME"
  APP_DB_USER="DATABASE_USER"
  APP_DB_PWD="DATABASE_PASSWORD"
  APP_EMAIL_USER="CUENTA_DE_CORREO"
  APP_EMAIL_PWD="PASSWORD_DEL_CORREO"
  APP_EMAIL_HOST="SERVIDOR_SMTP" // Para pruebas se puede utilizar los servicios de Mailtrap
  APP_EMAIL_PORT="SMTP_PORT"
  APP_JWT_SECRET="LA_CLAVE_PARA_JWT"
  APP_JWT_EXPIRES=TIEMPO_PARA_EXPIRAR_EL_TOKEN // Ejemplo: 43200000 (12 horas)
  APP_JWT_REFRESH=86400000
  APP_TIMEZONE="TIME_ZONE" // Ejemplo: America/Asuncion
  APP_MODO="dev" // Modo de profile (dev o prod)
  

Instalación

1. Clona el repo

   git clone https://github.com/mroncatto/voluntarios-backend

2. Abre con Eclipse o IntelliJ
3. Realiza ajustes a (application-dev.yml) si necesario
4. Certifique que las variables de ambiente fueron declaradas
5. Inicia el servicio

Uso

• Utiliza Postman u otro servicio para manipular metodos HTTP
• Abre la documentación (http://localhost:8180)

Licencia

Distribuido bajo la licencia MIT. Hecha un vistazo en Licencia MIT para obtener más información.