Documentación Front-End

Pages
- Lineamientos Generales Front-end
  Planning Poker
- Preparacion del Ambiente de Desarollo
- Estructura de Archivos
- Buenas Practicas de desarrollo
- Documento de Despliegue de Proyecto a un Servidor
- Libreria de APIs
  Solicitud de Token y ejecución de API con JWT.
  Roles y permisos
  Usuarios
- Documentación Sistema Centralizado JUNAEB
  Documentación Front-End
  Listado de Funciones
- API de Desarrollo
  Usuarios
  GET - Listar Usuarios
  BUSCAR - USUARIOS - Pendiente
  POST - USUARIOS
  CREAR - USUARIOS
  ACTUALIZAR - USUARIOS
  PUT - USUARIOS
  BLOQUEAR DESBLOQUEAR - USUARIOS
  ELIMINAR- USUARIOS
  GET - FICHA USUARIOS
  TABLA DE PRUEBAS - SIGESREGISTROCIVIL
  GET - SIGESREGISTROCIVIL
  LISTAR - SIGESREGISTROCIVIL
  TABLAS DINAMICAS
  GET - TABLA DINAMICA
  Logs Cronología
  GET - Consultar_Cronologia
  POST - Insertar_Cronologia
  Login
  POST - ACCESS TOKEN
  GET - REFRESH TOKEN
  POST - RESTABLECER CONTRASEÑA
  POST - RESTABLECER CONTRASEÑA POR SISTEMA
  GET - VALIDACION TOKEN
  PUT - CAMBIO DE CONTRASEÑA
  Prestadores
  GET - LISTAR
  POST - CREAR PRESTADOR
  POST- MODIFICAR PRESTADOR
  GET - LISTAR PRESTADOR X ID ("Tarjeta resumen prestador")
  PUT - BLOQUEA/ DESBLOQUEA PRESTADOR
  PUT - ELIMINAR PRESTADOR
  POST - AGREGAR USUARIO EXTERNO CON PRESTADOR
  GET - FICHA DE PRESTADOR X USUARIO EXTERNO
  PUT - ELIMINACIÓN USUARIO EXTERNO CON PRESTADOR
  Licitaciones
  GET - FICHA RESUMEN
  PUT - ElIMINACIÓN LICITACION X PRESTADOR
  GET - LISTAR LICITACIONES PRESTADORES
  POST - AGREGAR LICITACIÓN POR PRESTADOR
  GET - LISTAR LICITACIONES
  Preparaciones
  GET - LISTAR PREPARACIONES
  GET - LISTAR TIPO RACION
  GET - LISTAR COMPONENTE SERVICIO
  POST - AGREGAR COMPONENTE DE SERVICIO
  PUT - ELIMINAR PREPARACION
  PUT - EDITAR PREPARACIÓN
  POST - INSERTAR PREPARACION
  GET - SECCIÓN DE INFOPMACIÓN DE LAS PREPARACIONES
  GET - LISTAR PREPARACIONES POR ID
  Productos
  GET - PRODUCTOS
  POST - INSERTAR TIPO PRODUCTO
  POST - INSERTAR PRODUCTO
  PUT - MODIFICAR PRODUCTO
  PUT - ELIMINAR PRODUCTO
  GET - LISTAR TIPO INGREDIENTES
  PUT - ELIMINAR TIPO PRODUCTO
  Aportes Nutricionales
  GET - LISTAR APORTES NUTRICIONALES

Explore

Buenas Practicas de desarrollo

Al crear cualquier archivo en el sistema, lo ideal es que tenga una structura basica que ayude a los demas desarrolladores a comprender que es lo que se realiza en el archichivo. es por esto que el en las primeras lineas del documento debe tener un comentario introductorio de la funcionalidad principal de este archivo.

⁠

Importaciones en los archivos se deberan realizar de la siguiente manera

Importaciones propias del la libreria de react

Importaciones de otras librerias a utilizar o modules.

importacion de APIS y Querys

Importaciones a componentes custom

llamados a los hooks

importaciones a archivos locales como imagenes y otros.

Intentando siempre de ordenarlas alfabeticamente, esto nos ayudará a analizar de manera mas rapida el codigo.

⁠

Se respetará la convencion para la creación de componentes y archivos en react por lo que el nombre del archivo del componente debera ser igual al nombre de la funcion ocupando segun el caso sea pertinente PascalCase

En el caso de los Hooks estos deberan siempre tener el prefijo “use” seguido por el nombre del hook, por esejmplo useGeneralFunctions.jsx

En el caso de las páginas estan tendran que tener el sufijo “Page” por ejemplo PrestadorPage.jsx

La extencion del archivo dependera de si el componente retornará un elemento JSX en ese caso la extencion tendra que ser .jsx; en el caso de que devuelva codigo javascript esta debera tener la extension .js

Las variables seran nombradas con snake_case y en el caso de que esas variables vengan del lado del servidor se deberá respetar la estructura de “nombre del atributo”_”nombre de la entidad”, por ejemplo id_preparacion, nombre_componente_servicio.

Gallery

Want to print your doc?
This is not the way.

Try clicking the ··· in the right corner or using a keyboard shortcut (

CtrlP

) instead.