martaalopez / atmiraFCT

1 stars 1 forks source link

ATMIRA FTC SISTEMA GESTION PROYECTOS - Backend

Logo

Índice:

  1. Acerca de
  2. Tecnologías Utilizadas
  3. Documentación
  4. Pre Requisitos
  5. Instalación
  6. Colaborar
  7. Colaboradores

Acerca de:

La API REST del Sistema de Gestión de Proyectos de ATMIRA FTC proporciona una plataforma robusta para gestionar proyectos, tareas y subtareas de manera eficiente y colaborativa. Desde el manejo de proyectos hasta la autenticación y autorización de usuarios, cada aspecto ha sido desarrollado con precisión y seguridad en mente.

> Versión Publicada V-1.0

Documentación:

Para obtener más detalles sobre los endpoints disponibles y cómo interactuar con la API, consulta la documentación en

Tecnologías Utilizadas:

Pre Requisitos:

Para ejecutar la aplicación backend, se requiere tener instalado Java 17 y otras dependencias necesarias para ejecutar una aplicación Spring Boot.

Instalación:

  1. Clona el repositorio https://github.com/luishidalgoa/Atmira_Backend
  2. Ejecuta la aplicación utilizando las siguientes alternativas:

    • Maven
      mvn spring-boot:run -DDB_USERNAME=<nombre> -DPORT=<recomendado = 8080> -DFront_URL=<recomendado = *> -DDB_PASSWORD=<password> -DDB_jdbc=<jdbc:mysql://localhost/atmira">
    • Docker

      En la carpeta raiz del proyecto

    docker build -t atmira .

    Una vez se ha construido la imagen, ahora

    docker run --rm -it -e "DB_USERNAME=<nombre>" -e "PORT=<recomendado = 8080>" -e "Front_URL=<recomendado = *>" -e "DB_PASSWORD=<password> -e "DB_jdbc=<jdbc:mysql://localhost/atmira"> atmira

    Colaborar:

Guía rápida:

  1. Haz un fork del proyecto.
  2. Clona tu fork (git clone <URL del fork>).
  3. Añade el repositorio original como remoto (git remote add upstream <URL del repositorio original>).
  4. Crea tu Rama de Funcionalidad (git switch -c feature/NuevaCaracteristica).
  5. Realiza tus Cambios (git commit -m 'Agregado: alguna NuevaCaracteristica').
  6. Haz Push a la Rama (git push origin feature/NuevaCaracteristica).
  7. Abre una pull request para revisar tus cambios.

Colaboradores:

Contribuidores

Stack Tecnologías:

Java Spring Apache Maven Docker Mocha