Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Develop #33

Merged
merged 15 commits into from
Feb 22, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
node_modules
coverage
docs/build
docs/build
.vscode
Binary file added docs/images/03_1_contexto-negocio.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/03_2_contexto_tecnico.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
388 changes: 386 additions & 2 deletions docs/package-lock.json

Large diffs are not rendered by default.

11 changes: 5 additions & 6 deletions docs/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,11 @@
"description": "Npm project just for the docs",
"main": "index.js",
"scripts": {
"build": "shx rm -rf build && asciidoctor -D build -a imagesdir=./images -r asciidoctor-diagram index.adoc && shx cp -R images build",
"deploy": "gh-pages -d build"
"build": "shx rm -rf build && asciidoctor -D build -a imagesdir=./images -r asciidoctor-diagram index.adoc && shx cp -R images build",
"deploy": "gh-pages -d build"
},
"dependencies": {
"gh-pages": "^3.2.3",
"shx": "^0.3.3"
"gh-pages": "^3.2.3",
"shx": "^0.3.3"
}
}

}
21 changes: 20 additions & 1 deletion docs/src/02_architecture_constraints.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,26 @@ ifndef::imagesdir[:imagesdir: ../images]

[role="arc42help"]
****
.Contents
Any requirement that constraints software architects in their freedom of design and implementation decisions or decision about the development process. These constraints sometimes go beyond individual systems and are valid for whole organizations and companies.

.Motivation
Architects should know exactly where they are free in their design decisions and where they must adhere to constraints.
Constraints must always be dealt with; they may be negotiable, though.

.Form
Simple tables of constraints with explanations.
If needed you can subdivide them into
technical constraints, organizational and political constraints and
conventions (e.g. programming or versioning guidelines, documentation or naming conventions)


.Further Information

See https://docs.arc42.org/section-2/[Architecture Constraints] in the arc42 documentation.

****

Este proyecto está limitado por una serie de pautas marcadas por los responsables de la asignatura.
Por ello esta aplicación está desarrollada siguiendo una serie de requisitos los cuales nombraremos a continuación.

Expand Down Expand Up @@ -62,4 +82,3 @@ a través de nuestro grupo de WhatsApp y en casos necesarios realizamos reunione
|*Accesibilidad*
|_Nuestro aplicación puede ser utilizada por cualquier tipo de usuario hispanohablante, sin importar quien sea, ya que será fácil de entender e interactuar._
|===
****
16 changes: 5 additions & 11 deletions docs/src/03_system_scope_and_context.adoc
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
ifndef::imagesdir[:imagesdir: ../images]

[[section-system-scope-and-context]]
== System Scope and Context
== Alcance y Contexto del Sistema


[role="arc42help"]
Expand Down Expand Up @@ -29,7 +29,7 @@ See https://docs.arc42.org/section-3/[Context and Scope] in the arc42 documentat
****


=== Business Context
=== Contexto de Negocio

[role="arc42help"]
****
Expand All @@ -48,11 +48,9 @@ The title of the table is the name of your system, the three columns contain the

****

**<Diagram or Table>**
image::03_1_contexto-negocio.png["Diagrama de contexto de negocio"]

**<optionally: Explanation of external domain interfaces>**

=== Technical Context
=== Contexto Técnico

[role="arc42help"]
****
Expand All @@ -68,8 +66,4 @@ together with a mapping table showing the relationships between channels and inp

****

**<Diagram or Table>**

**<optionally: Explanation of technical interfaces>**

**<Mapping Input/Output to Channels>**
image::03_2_contexto_tecnico.png["Diagrama de contexto técnico"]
12 changes: 12 additions & 0 deletions docs/src/04_solution_strategy.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -30,3 +30,15 @@ Refer to details in the following sections.
See https://docs.arc42.org/section-4/[Solution Strategy] in the arc42 documentation.

****

* *JavaScript*: Este lenguaje es muy buena opción para utilizar en proyectos en que se emplé la tecnología REACT. Nos pareció mejor opción que otros lenguajes como TypeScript debido a que su compresión y manejo es más sencillo.

* *React*: Esta libreria de JavaScript permite la creación de interfaces de usuario para la aplicacion web, simplificando la creación de interfaces gráficas.

* *Docker*: Utilizaremos los contenedores de Docker como lugar donde desplegar la aplicacion web, de manera que pueda probarse la aplicación de forma aislada.

* *Firebase*: Esta API nos servirá como sistema de autenticación del usuario para poder llevar un registro de su historial de partidas, así como algunas de sus estadísticas.

* *WikiData*: Se trata de otra API a partir de la cual se generarán aleatoriamente las preguntas y respuestas, tanto correctas como incorrectas, que el usuario visualizará.

* *Microservicios:* Enfoque arquitectónico donde el software está compuesto por pequeños servicios independientes. Lo hemos elegido por encima de MVC, por la facilidad a la hora de modificar una parte de la aplicación sin afectar al resto.
30 changes: 28 additions & 2 deletions docs/src/11_technical_risks.adoc
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
ifndef::imagesdir[:imagesdir: ../images]

[[section-technical-risks]]
== Risks and Technical Debts
== Riesgos y Deudas Técnicas


[role="arc42help"]
Expand All @@ -17,9 +17,35 @@ This should be your motto for systematic detection and evaluation of risks and t
.Form
List of risks and/or technical debts, probably including suggested measures to minimize, mitigate or avoid risks or reduce technical debts.


.Further Information

See https://docs.arc42.org/section-11/[Risks and Technical Debt] in the arc42 documentation.

****

=== Riesgos Técnicos

[cols="e,2e" options="header"]
|===
|Riesgo |Explicación

|*Abandono*
|_Durante el desarrollo del proyecto cabe la posibilidad de que alguno de los miembros que conforman el equipo abandone este, provocando un serio problema el ritmo y carga
de trabajo de los demás compañeros._

|*Otras Asignaturas*
|_Las demás asignaturas en la que están matriculados los miembros del equipo puede exigir una carga importante de trabajo por lo que provocar que el equipo no dedique el
suficiente tiempo al desarrollo de este proyecto._

|*Errores*
|_Durante las pruebas de la aplicación pueden surgir errores que nos obliguen a realizar importantes cambios en esta. Esto puede provocar que el equipo invierta más horas de
las planeadas para solucionar este tipo de problemas._

|*Caída de Servicios*
|_El desarrollo del proyecto puede verse afectado si alguno de los servicios utilizados, como por ejemplo Docker, pueden no funcionar en algún momento. Esto podría bloquear la entrega de alguna de las
funcionalidades del proyecto._

|===



39 changes: 35 additions & 4 deletions docs/src/12_glossary.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -34,9 +34,40 @@ See https://docs.arc42.org/section-12/[Glossary] in the arc42 documentation.
|===
|Term |Definition

|<Term-1>
|<definition-1>
|*API*
|Interfaz de programación de aplicaciones que permite la comunicación entre diferentes programas de software.

|*Arc42*
|Un marco de arquitectura que proporciona un conjunto de prácticas y plantillas para documentar y diseñar arquitecturas de software.

|*Back-end*
|La parte de un sitio web o aplicación que no es visible para los usuarios finales y se encarga del procesamiento de la lógica del negocio y la gestión de los datos.

|*Contenedor*
|Entorno virtual ligero que contiene todo lo necesario para ejecutar una aplicación, incluidas bibliotecas, herramientas y códigos.

|*Docker*
|Plataforma de código abierto que automatiza el despliegue de aplicaciones dentro de contenedores de software.

|*Front-end*
|La parte de un sitio web o aplicación que interactúa directamente con los usuarios, visible y accesible en el navegador.

|*GitHub*
|Plataforma de desarrollo colaborativo para alojar proyectos utilizando el sistema de control de versiones Git.

|*IDE*
|Entorno de desarrollo integrado que proporciona herramientas y características para facilitar la escritura y depuración de código.

|*JavaScript*
|Lenguaje de programación utilizado principalmente para agregar interactividad y dinamismo a sitios web.

|*Saber y Ganar*
|Programa de televisión español de tipo concurso de preguntas y respuestas culturales.

|*TypeScript*
|Lenguaje de programación de código abierto desarrollado por Microsoft que es un superset de JavaScript y añade tipos estáticos opcionales a la sintaxis del lenguaje.

|*WikiData*
|Base de datos colaborativa libre que almacena datos estructurados para respaldar proyectos de la Fundación Wikimedia.

|<Term-2>
|<definition-2>
|===
Loading