TP DSW

tags: #dsw #tp

Status: draft

1. Objetivo

Desarrollar en grupo una aplicación web full stack en base a un alcance propuesto por los integrantes.

Durante dicho desarrollo se deberá aplicar todo lo aprendido en la materia Desarrollo de Software.

2. Tema y Alcance

El grupo debe deberá proponer a los docentes un tema para el trabajo práctico de su preferencia utilizando la plantilla de propuesta

3. Requisitos

El desarrollo de la aplicación debe:

1. Desarrollarse en 2 partes: Frontend y Backend; agnósticas entre si, comunicadas mediante una API.
2. Cumplir con los requisitos: técnicos y funcionales.
3. Desarrollarse en grupo utilizando metodologías de gestión de proyecto y llevar evidencia de ello.
4. Cumplir con las entregas estipuladas.
5. Utilizar github o gitlab para gestión del código fuente.
6. Realizar una defensa oral del trabajo práctico para regularidad.
7. Realizar otra defensa oral del trabajo práctico para la aprobación.
8. Enviar la
9. Presentar la documentación durante la defensa.

3.1 Requisitos técnicos

La app cuenta con 2 partes: Backend y Frontend agnósticas entre si que se comunican mediante una API.

3.1.1 Backend

El backend debe cumplir con las siguientes condiciones para regularidad y aprobación.

Regularidad

• Desarrollarse en JavaScript.
• Utilizar un framework web que permita integrarse a las demás.
• herramientas a través de middlewares, pluggins o modulos.
• Exponer una API web (rest, tRPC o gRPC) para interactuar con el frontend.
• Utilizar una base de datos persistente que acceda a través de un servicio externo (es decir que no sea una base de datos embebida).
• La persistencia a la base de datos debe realizarse mediante un mapper (ORM/ODM/OXM). En caso que la base de datos utilizada no tenga un mapper disponible para JavaScript se deberá implementar la persistencai utilizando un patron Repository.
• Realizarse mediante capas.
• Validar entrada de datos, manejar e informar apropiadamente los errores a través de la API.
• Las dependencias para ejecución, desarrollo y test deben estar correctamente registradas para ser instaladas automáticamente (e.j. package.json).

Aprobación Directa o en Examen

• Cumplir con todas las condiciones de regularidad.
• Implementar 1 test automatizado por integrante.
• Implementar 1 test de integración.
• Implementar un login con autenticación propia o de third-party y al menos 2 niveles de acceso diferentes.
• Proteger las diferentes rutas en base al nivel de acceso requerido.
• Definir ambientes, ya sea mediante environment del framework o .env

3.1.2 Frontend

El frontend debe cumplir con las siguientes condiciones para regularidad y aprobación.

Regularidad

• Desarrollarse utilizando un framework de Frontend.
• Utilizar HTML5
• Utilizar CSS según las directrices de alguna biblioteca de componentes, guía de estilo o framework de CSS y la metodología propuesta por el framework de frontend elegido. Se sugiere el uso de biblioteca de componentes; preprocesadores: sass, scss, less, stylus, etc o frameworks de css: Pico.css, Bulma, Material, Tailwind, Bootstrap, etc.
• Guía de estilos sugerida Airbnb Javascript https://github.com/airbnb/javascript
• Aplicar la estrategia mobile-first para la escritura del código css de la aplicación
• La app debe visualizarse correctamente en al menos 3 diferentes breakpoints: SM, MD, LG
• Seguir buenas prácticas de UX/UI ( Que no requiera manual de usuario o explicaciones específicas para utilizar la interfaz )
• Las app debe mostrar las siguientes características entre sus componentes:
  • Manejo de eventos del usuario: click, input, etc
  • Ante una posibilidad de fallo, manejar el/los errores adecuadamente y de manera amigable al usuario
  • Reactividad ante un estado
  • Input property
  • Output property
• Implementar al menos un servicio.
• Para el manejo de la información, por ej una respuesta de un endpoint o los datos a enviar en una request, representar en el código los modelos de objetos con clases, interfaces y tipos de datos custom.
• De ser posible, implementar algún patrón de diseño orientado a objetos.
• Las dependencias para ejecución, desarrollo y test deben estar correctamente registradas para ser instaladas automáticamente (e.j. package.json).

Aprobación Directa o en Examen

• Cumplir con las condiciones de regularidad.
• Realizar al menos 1 test unitario de un componente.
• Realizar al menos 1 test de end-to-end.
• Implementar el login y proteger el acceso a las distintas partes del frontend en base a los niveles de usuarios del backend.
• Definir ambientes, ya sea mediante environment del framework o .env

3.2 Requisitos funcionales

La app debe cumplir con los siguientes requisitos.

Regularidad

• 1 CRUD Simple por integrante
• 1 CRUD Dependiente cada 2 integrantes o fracción.
• 1 Listado con filtro (al menos un atributo) cada 2 integrantes o fracción.
• Para cada listado, al seleccionar un elemento, se debe mostrar un detalle.
• Debe implementar un caso de uso de usuario o epic, con valor para el negocio, cada 2 integrantes o fracción.

Aprobación Directa o en Examen

• CRUDs de todas las clases de negocio necesarias para el funcionamiento de la app.
• Implementar 1 caso de uso usuario o epic, con valor para el negocio, por cada integrante. Se deben implementar un mínimo de 2 relacionados entre si. Es decir que la data registrada por uno CU o epic sirva de input para otro.

Alcance Adicional Voluntario

De forma opcional y voluntaria los grupos podrán realizar CUU o epics, listados más complejos de los solicitados u otros requisitos como notificaciones, logs, etc; adicionales para completar la funcionalidad del sistema propuesto.

Esto será considerado en la nota final en función de la complejidad y esfuerzo relativos a lo ya realizado.

3.3 Entregas

Propuesta del enunciado

En la entrega se debe entregar a los profesores la plantilla de propuesta actualizada con las condiciones de Regularidad y de Aprobación. Los profesores analizarán la propuesta y de ser necesario sugerirán ajustes hasta que esté correcta y sea aceptada.

Regularidad

En la entrega se debe

• Incluir en el README.md (o con un link) las instrucciones para instalar y ejecutar el proyecto sin conocimientos de cómo está desarrollado. El proyecto debe poder ejecutarse con scripts y las herramientas según las convenciones del lenguaje y/o framework utilizado (scripts en package.json, o tools específicas del framework).
• Entregar la proposal actualizada con links al pull request de back y/o front.
• Coordinar una defensa grupal con los profesores.

Aprobación Directa o en Examen

En la entrega se debe:

• Video explicando el funcionamiento del sistema
• Documentación de la API de backend (según la tecnología y standard utilizados).
• Evidencia del resultado de la ejecución de los tests automáticos.
• Entregar la proposal actualizada con links al pull request de back y/o front.
• Incluir en el README.md (o con un link) las instrucciones para instalar y ejecutar el proyecto sin conocimientos de cómo está desarrollado. El proyecto debe poder ejecutarse con scripts y las herramientas según las convenciones del lenguaje y/o framework utilizado (scripts en package.json, o tools específicas del framework).
• Deploy: A definir
• Coordinar una defensa grupal con los profesores.

Fechas de entrega

TODO: A definir Propuesta: 23/06/2023

Muestra de avance: TBD

Entrega de Regularidad: TBD

Entrega de Aprobación: TBD

• Directa:
• En examen:

3.4 Documentación

La documentación debe presentarse para la instancia de defensa.

Para conocer el detalle de la documentación referirse a docs.

4. Gestión del proyecto

TODO: En revisión

El desarrollo de la app debe realizarse utilizando metodologías ágiles para la gestión del proyecto (Scrum, XP, etc).

El grupo deberá llevar un registro de lo realizado, el mismo debe incluir como mínimo:

• Tipo de metodología a utilizar para el seguimiento. ( Scrum, XP, etc.)
• Minutas de avances o reuniones de coordinación del equipo.
• Documentación de trackeo como desarrollo de features y bugfix, asignación de tareas, etc.

Es de libre elección del alumno la herramienta a utilizar para el trackeo. Se recomienda el uso de github/gitlab proyects para integrar con el desarrollo de la misma pero en caso de utilizar otra en la documentación deberán incluirse los links a la tool para ello.

5. Evaluación

TODO: En revisión.

Durante la evaluación de cada entrega se considerarán:

• Requisitos técnicos y funcionales de la etapa.
• Adhesión a las directrices de UX/UI y buenas prácticas de programación.
• Uso apropiado de la tecnología: librerías, frameworks, patrones, etc.
• Documentación requerida.
• Participación de los miembros del grupo.
• Uso de git para el desarrollo.
• Defensa oral del trabajo práctico.
• Gestión y seguimiento del desarrollo de la app.
• Innovación, investigación y desafíos asumidos.

6. FAQ

En la sección de FAQ podrán encontrar respuestas a las consultas más frecuentes que se van realizando.