Compare commits
13 Commits
a993f2bcbf
...
6e048cc906
Author | SHA1 | Date | |
---|---|---|---|
6e048cc906 | |||
d957bfc07d | |||
be987dfbed | |||
57fe16f9ce | |||
480ff06731 | |||
8e3511472d | |||
c6bdd2fe2e | |||
4404ec6504 | |||
52d19ed9f5 | |||
f014199042 | |||
393a7c031d | |||
2c22e88e63 | |||
2d07f0feba |
@@ -1,27 +1,21 @@
|
|||||||
name: Deploy Documentation Local
|
name: Deploy Documentation Local
|
||||||
run-name: Deploying ${{ gitea.repository }} docs locally
|
run-name: Deploying ${{ vars.GIT_REPOSITORY }} docs locally
|
||||||
|
|
||||||
on:
|
on:
|
||||||
workflow_dispatch:
|
|
||||||
branches:
|
|
||||||
- dev
|
|
||||||
paths:
|
|
||||||
- "docs/**"
|
|
||||||
push:
|
push:
|
||||||
branches:
|
branches: [dev]
|
||||||
- dev
|
paths: ["docs/**", "mkdocs.yml", ".gitea/workflows/deploy-docs-dev.yaml"]
|
||||||
paths:
|
workflow_dispatch:
|
||||||
- "docs/**"
|
inputs:
|
||||||
|
branch:
|
||||||
|
description: "Branch to deploy"
|
||||||
|
required: true
|
||||||
|
default: "dev"
|
||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
deploy-docs:
|
deploy-docs:
|
||||||
runs-on: windows # Ejecutar directamente en el host Windows
|
runs-on: windows # Ejecutar directamente en el host Windows
|
||||||
steps:
|
steps:
|
||||||
- name: Set up node
|
|
||||||
shell: powershell
|
|
||||||
run: |
|
|
||||||
nvs use latest
|
|
||||||
|
|
||||||
- name: Check out repository code
|
- name: Check out repository code
|
||||||
uses: actions/checkout@v4
|
uses: actions/checkout@v4
|
||||||
|
|
||||||
@@ -36,15 +30,15 @@ jobs:
|
|||||||
|
|
||||||
- name: Build documentation
|
- name: Build documentation
|
||||||
run: |
|
run: |
|
||||||
cd docs
|
ls
|
||||||
mkdocs build --site-dir ../build
|
mkdocs build --site-dir ../build
|
||||||
|
|
||||||
- name: Deploy to IIS directory
|
- name: Deploy to IIS directory
|
||||||
shell: powershell
|
shell: powershell
|
||||||
run: |
|
run: |
|
||||||
$projectName = "${{ gitea.repository_name }}"
|
$projectName = "${{ vars.GIT_REPOSITORY }}"
|
||||||
$basePath = "${{ secrets.DEPLOY_BASE_PATH }}"
|
$basePath = Join-Path "${{ secrets.DEPLOY_BASE_PATH }}" "dev"
|
||||||
$targetPath = Join-Path $basePath "dev" $projectName
|
$targetPath = Join-Path $basePath $projectName
|
||||||
|
|
||||||
# Crear directorio del proyecto si no existe
|
# Crear directorio del proyecto si no existe
|
||||||
if (Test-Path $targetPath) {
|
if (Test-Path $targetPath) {
|
||||||
@@ -53,7 +47,7 @@ jobs:
|
|||||||
New-Item -ItemType Directory -Path $targetPath -Force
|
New-Item -ItemType Directory -Path $targetPath -Force
|
||||||
|
|
||||||
# Copiar archivos construidos
|
# Copiar archivos construidos
|
||||||
Copy-Item -Path "build\*" -Destination $targetPath -Recurse -Force
|
Copy-Item -Path "..\build\*" -Destination $targetPath -Recurse -Force
|
||||||
|
|
||||||
Write-Host "Documentation deployed to: $targetPath"
|
Write-Host "Documentation deployed to: $targetPath"
|
||||||
|
|
||||||
@@ -74,7 +68,7 @@ jobs:
|
|||||||
<head>
|
<head>
|
||||||
<meta charset="UTF-8">
|
<meta charset="UTF-8">
|
||||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||||
<title>Documentación - MCV Ingenieros</title>
|
<title>Documentacion - MCV Ingenieros</title>
|
||||||
<style>
|
<style>
|
||||||
* {
|
* {
|
||||||
margin: 0;
|
margin: 0;
|
||||||
@@ -188,8 +182,8 @@ jobs:
|
|||||||
<body>
|
<body>
|
||||||
<div class="container">
|
<div class="container">
|
||||||
<div class="header">
|
<div class="header">
|
||||||
<h1>📚 Centro de Documentación</h1>
|
<h1>Centro de Documentacion</h1>
|
||||||
<p>MCV Ingenieros - Documentación de Proyectos</p>
|
<p>MCV Ingenieros - Documentacion de Proyectos</p>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div class="projects">
|
<div class="projects">
|
||||||
@@ -202,10 +196,8 @@ jobs:
|
|||||||
$htmlContent += @"
|
$htmlContent += @"
|
||||||
<div class="project-card">
|
<div class="project-card">
|
||||||
<a href="./$folderName/" class="project-link">
|
<a href="./$folderName/" class="project-link">
|
||||||
<span class="project-icon">📖</span>
|
|
||||||
<h3 class="project-title">$folderName</h3>
|
<h3 class="project-title">$folderName</h3>
|
||||||
<div class="project-meta">
|
<div class="project-meta">
|
||||||
<span>🕒</span>
|
|
||||||
<span>Actualizado: $lastWrite</span>
|
<span>Actualizado: $lastWrite</span>
|
||||||
</div>
|
</div>
|
||||||
</a>
|
</a>
|
||||||
@@ -218,7 +210,7 @@ jobs:
|
|||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div class="footer">
|
<div class="footer">
|
||||||
<p>Índice generado automáticamente el $currentDate</p>
|
<p>Indice generado automaticamente el $currentDate</p>
|
||||||
<p>Powered by Gitea Actions & IIS</p>
|
<p>Powered by Gitea Actions & IIS</p>
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
@@ -2,6 +2,10 @@
|
|||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
|
## Relacionado
|
||||||
|
|
||||||
|
- [Introducción](introduccion.md)
|
||||||
|
|
||||||
## Propósito
|
## Propósito
|
||||||
|
|
||||||
Crear una plataforma web que permita a fotógrafos profesionales almacenar, distribuir y colaborar con sus clientes en la gestión de imágenes digitales de manera eficiente y segura.
|
Crear una plataforma web que permita a fotógrafos profesionales almacenar, distribuir y colaborar con sus clientes en la gestión de imágenes digitales de manera eficiente y segura.
|
||||||
|
@@ -1,5 +1,12 @@
|
|||||||
# Galerías Fotográficas - Análisis técnico
|
# Galerías Fotográficas - Análisis técnico
|
||||||
|
|
||||||
|
## Relacionado
|
||||||
|
|
||||||
|
- [Introducción](introduccion.md)
|
||||||
|
- [Acta de constitución](acta-constitucion.md)
|
||||||
|
- [Decisiones de arquitectura](decisiones-arquitectura.md)
|
||||||
|
- [Documentación de la API](documentacion-api.md)
|
||||||
|
|
||||||
## Arquitectura del sistema
|
## Arquitectura del sistema
|
||||||
|
|
||||||
Queremos hacer un sistema modular, con componentes independientes que se puedan desarrollar, probar e implementar de forma aislada.
|
Queremos hacer un sistema modular, con componentes independientes que se puedan desarrollar, probar e implementar de forma aislada.
|
||||||
|
@@ -1,5 +1,12 @@
|
|||||||
# Galerías Fotográficas - Casos de Uso
|
# Galerías Fotográficas - Casos de Uso
|
||||||
|
|
||||||
|
## Relacionado
|
||||||
|
|
||||||
|
- [Introducción](introduccion.md)
|
||||||
|
- [Acta de constitución](acta-constitucion.md)
|
||||||
|
- [Análisis técnico](analisis-tecnico.md)
|
||||||
|
- [Requisitos funcionales](requisitos-funcionales.md)
|
||||||
|
|
||||||
## Caso de uso 1: Administrador da de alta un nuevo profesional
|
## Caso de uso 1: Administrador da de alta un nuevo profesional
|
||||||
|
|
||||||
1. El administrador accede al sistema.
|
1. El administrador accede al sistema.
|
||||||
|
@@ -1,5 +1,12 @@
|
|||||||
# Galerías Fotográficas - Decisiones de Arquitectura
|
# Galerías Fotográficas - Decisiones de Arquitectura
|
||||||
|
|
||||||
|
## Relacionado
|
||||||
|
|
||||||
|
- [Introducción](introduccion.md)
|
||||||
|
- [Acta de constitución](acta-constitucion.md)
|
||||||
|
- [Análisis técnico](analisis-tecnico.md)
|
||||||
|
- [Requisitos funcionales](requisitos-funcionales.md)
|
||||||
|
|
||||||
## ¿Por qué Angular en lugar de React?
|
## ¿Por qué Angular en lugar de React?
|
||||||
|
|
||||||
Como producto final, se pretende vender varias plantillas frontales.
|
Como producto final, se pretende vender varias plantillas frontales.
|
||||||
|
@@ -1,5 +1,12 @@
|
|||||||
# Galerías Fotográficas - Documentación API
|
# Galerías Fotográficas - Documentación API
|
||||||
|
|
||||||
|
## Relacionado
|
||||||
|
|
||||||
|
- [Introducción](introduccion.md)
|
||||||
|
- [Acta de constitución](acta-constitucion.md)
|
||||||
|
- [Decisiones de arquitectura](decisiones-arquitectura.md)
|
||||||
|
- [Análisis técnico](analisis-tecnico.md)
|
||||||
|
|
||||||
## Autenticación y autorización
|
## Autenticación y autorización
|
||||||
|
|
||||||
POST `/auth/login` -> Inicia sesión y devuelve un token de autenticación.
|
POST `/auth/login` -> Inicia sesión y devuelve un token de autenticación.
|
||||||
|
@@ -1,4 +1,10 @@
|
|||||||
# Galerías Fotográficas - Guía de Estilo
|
# Galerías Fotográficas - Guía de Estilo UI/UX
|
||||||
|
|
||||||
|
## Relacionado
|
||||||
|
|
||||||
|
- [Introducción](introduccion.md)
|
||||||
|
- [Acta de constitución](acta-constitucion.md)
|
||||||
|
- [Requisitos funcionales](requisitos-funcionales.md)
|
||||||
|
|
||||||
## Materiales
|
## Materiales
|
||||||
|
|
29
docs/index.md
Normal file
29
docs/index.md
Normal file
@@ -0,0 +1,29 @@
|
|||||||
|
# Índice del Proyecto
|
||||||
|
|
||||||
|
## Descripción del Proyecto
|
||||||
|
|
||||||
|
Este proyecto, **Galerías Fotográficas**, proporciona una plataforma para organizar, visualizar y gestionar colecciones de fotografías. Incluye documentación sobre la finalidad del proyecto, instrucciones detalladas para la instalación y configuración, ejemplos de uso, una sección de preguntas frecuentes y canales de contacto para soporte. El objetivo es facilitar la creación y administración de galerías fotográficas de manera sencilla y eficiente.
|
||||||
|
|
||||||
|
## Contenido
|
||||||
|
|
||||||
|
- [Acta de constitución](acta-constitucion.md)
|
||||||
|
|
||||||
|
- [Análisis técnico](analisis-tecnico.md)
|
||||||
|
|
||||||
|
- [Casos de uso](casos-uso.md)
|
||||||
|
|
||||||
|
- [Decisiones de arquitectura](decisiones-arquitectura.md)
|
||||||
|
|
||||||
|
- [Documentación de la API](documentacion-api.md)
|
||||||
|
|
||||||
|
- [Guía de estilo](guia-estilo.md)
|
||||||
|
|
||||||
|
- [Introducción](introduccion.md)
|
||||||
|
|
||||||
|
- [Manual de usuario](manual-usuario.md)
|
||||||
|
|
||||||
|
- [Plan de desarrollo](plan-desarrollo.md)
|
||||||
|
|
||||||
|
- [Plan de pruebas](plan-testing.md)
|
||||||
|
|
||||||
|
- [Requisitos funcionales](requisitos-funcionales.md)
|
@@ -2,6 +2,10 @@
|
|||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
|
## Relacionado
|
||||||
|
|
||||||
|
- [Acta de constitución](acta-constitucion.md)
|
||||||
|
|
||||||
## Que problema identificamos
|
## Que problema identificamos
|
||||||
|
|
||||||
Existen multiples alternativas para la distribución de imágenes digitales, como redes sociales o proveedores de almacenamiento en la nube.
|
Existen multiples alternativas para la distribución de imágenes digitales, como redes sociales o proveedores de almacenamiento en la nube.
|
||||||
|
@@ -6,4 +6,11 @@ Guía para clientes
|
|||||||
|
|
||||||
FAQ y resolución de problemas
|
FAQ y resolución de problemas
|
||||||
|
|
||||||
Videos tutoriales (cuando aplique) -->
|
Videos tutoriales (cuando aplique) -->
|
||||||
|
|
||||||
|
# Galerías Fotográficas - Guía de Usuario
|
||||||
|
|
||||||
|
## Relacionado
|
||||||
|
|
||||||
|
- [Introducción](introduccion.md)
|
||||||
|
- [Acta de constitución](acta-constitucion.md)
|
||||||
|
@@ -1,5 +1,12 @@
|
|||||||
# Galerías Fotográficas - Plan de Desarrollo
|
# Galerías Fotográficas - Plan de Desarrollo
|
||||||
|
|
||||||
|
## Relacionado
|
||||||
|
|
||||||
|
- [Introducción](introduccion.md)
|
||||||
|
- [Acta de constitución](acta-constitucion.md)
|
||||||
|
- [Análisis técnico](analisis-tecnico.md)
|
||||||
|
- [Requisitos funcionales](requisitos-funcionales.md)
|
||||||
|
|
||||||
## Fase 1 Backend: Configuración básica y autenticación
|
## Fase 1 Backend: Configuración básica y autenticación
|
||||||
|
|
||||||
- Configuración del entorno de desarrollo.
|
- Configuración del entorno de desarrollo.
|
||||||
|
@@ -8,4 +8,13 @@ Pruebas E2E: Flujos completos de usuario
|
|||||||
|
|
||||||
Pruebas de rendimiento: Carga de imágenes
|
Pruebas de rendimiento: Carga de imágenes
|
||||||
|
|
||||||
Criterios de aceptación -->
|
Criterios de aceptación -->
|
||||||
|
|
||||||
|
# Galerías Fotográficas - Plan de Pruebas
|
||||||
|
|
||||||
|
## Relacionado
|
||||||
|
|
||||||
|
- [Introducción](introduccion.md)
|
||||||
|
- [Acta de constitución](acta-constitucion.md)
|
||||||
|
- [Análisis técnico](analisis-tecnico.md)
|
||||||
|
- [Requisitos funcionales](requisitos-funcionales.md)
|
||||||
|
@@ -2,6 +2,13 @@
|
|||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
|
## Relacionado
|
||||||
|
|
||||||
|
- [Introducción](introduccion.md)
|
||||||
|
- [Acta de constitución](acta-constitucion.md)
|
||||||
|
- [Manual de usuario](manual-usuario.md)
|
||||||
|
- [Casos de uso](casos-uso.md)
|
||||||
|
|
||||||
## Gestión de usuarios (4 tipos: anónimo, cliente, profesional, administrador)
|
## Gestión de usuarios (4 tipos: anónimo, cliente, profesional, administrador)
|
||||||
|
|
||||||
Existirán 4 tipos de usuarios:
|
Existirán 4 tipos de usuarios:
|
||||||
|
14
mkdocs.yml
Normal file
14
mkdocs.yml
Normal file
@@ -0,0 +1,14 @@
|
|||||||
|
site_name: Galerías Fotográficas
|
||||||
|
site_description: Documentación del proyecto de Galerías Fotográficas
|
||||||
|
|
||||||
|
nav:
|
||||||
|
- Requisitos Funcionales: requisitos-funcionales.md
|
||||||
|
- Análisis Técnico: analisis-tecnico.md
|
||||||
|
- Guía de Estilo: guia-estilo-uiux.md
|
||||||
|
- Hoja de ruta: plan-desarrollo.md
|
||||||
|
|
||||||
|
theme:
|
||||||
|
name: mkdocs
|
||||||
|
color_mode: auto
|
||||||
|
user_color_mode_toggle: true
|
||||||
|
locale: es
|
Reference in New Issue
Block a user