https://github.com/yracnet/ci01-uargm
https://github.com/yracnet/ci01-uargm
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/yracnet/ci01-uargm
- Owner: yracnet
- Created: 2024-06-24T13:56:04.000Z (over 1 year ago)
- Default Branch: release
- Last Pushed: 2024-12-28T06:20:00.000Z (10 months ago)
- Last Synced: 2025-04-24T00:49:41.336Z (6 months ago)
- Language: TypeScript
- Size: 1.19 MB
- Stars: 0
- Watchers: 1
- Forks: 2
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# CI-Green
## Visión general
**CI-Green** es un proyecto Node.js con APIs para gestionar clientes, empleados y productos.
## Entorno
- NODE 20
- YARN
## Instalación
```bash
# Clonar el repositorio
git clone https://github.com/yracnet/ci01-uargm
cd ci-green
# Instalar dependencias
yarn install
# Color Rojo
yarn add @material-ui/core @material-ui/styles
```
## Configuracion
Crear los archivo `.env.xxx` en la raiz del proyecto
```bash
#.env.test
MONGO_DB_URL=mongodb+srv://<>:<>@mongodb.net/green
```
```bash
#in the file: .env.test
MONGO_DB_URL=mongodb+srv://<>:<>@mongodb.net/green-test
```
## Execucion
```bash
# Iniciar servidor de desarrollo con Vite
yarn dev
# Compilar archivos TypeScript y luego construir con Vite
yarn build
# Ejecutar pruebas con cobertura
yarn test
```
## APIs
### Clientes
```json
{
"nombre": "string",
"email": "string",
"telefono": "string",
"direccion": "string",
"tipoDocumento": "string",
"documento": "string",
"fechaRegistro": "Date"
}
```
- **GET** `/api/clientes/`
Obtiene una lista de clientes.
- **PUT** `/api/clientes/`
Crea un nuevo cliente.
- **POST** `/api/clientes/`
Actualiza un cliente existente especificado por ID.
- **GET** `/api/clientes/:id`
Obtiene detalles de un cliente específico.
- **PATCH** `/api/clientes/:id`
Actualiza campos específicos de un cliente.
- **DELETE** `/api/clientes/:id`
Elimina un cliente especificado por ID.
### Empleados
```json
{
"nombre": "string",
"cargo": "string",
"departamento": "string",
"fechaContratacion": "Date",
"salario": "number",
"email": "string",
"telefono": "string"
}
```
- **GET** `/api/empleados/`
Obtiene una lista de empleados.
- **PUT** `/api/empleados/`
Crea un nuevo empleado.
- **POST** `/api/empleados/`
Actualiza un empleado existente especificado por ID.
- **GET** `/api/empleados/:id`
Obtiene detalles de un empleado específico.
- **PATCH** `/api/empleados/:id`
Actualiza campos específicos de un empleado.
- **DELETE** `/api/empleados/:id`
Elimina un empleado especificado por ID.
### Productos
```json
{
"nombre": "string",
"descripcion": "string",
"precio": "number",
"stock": "number",
"categoria": "string",
"proveedor": "string",
"fechaRegistro": "Date"
}
```
- **GET** `/api/productos/`
Obtiene una lista de productos.
- **PUT** `/api/productos/`
Crea un nuevo producto.
- **POST** `/api/productos/`
Actualiza un producto existente especificado por ID.
- **GET** `/api/productos/:id`
Obtiene detalles de un producto específico.
- **PATCH** `/api/productos/:id`
Actualiza campos específicos de un producto.
- **DELETE** `/api/productos/:id`
Elimina un producto especificado por ID.
## Despliegue
El branch `release` es monitoreado por el Pile ci.yml para su despliegue, la URL de despliegue es:
> https://ci01-uagrm-latest.onrender.com/
## Test Report
Los resultados de las Pruebas Unitarioas y de covertura, se publican en GitHub-Pages
## Reporte de Prubas
### Reporte
> https://yracnet.github.io/ci01-uargm/
### Coverage
> https://yracnet.github.io/ci01-uargm/coverage/
### Pruebas Estaticas
> https://app.snyk.io/org/yracnet/projects?groupBy=targets&before&after&searchQuery=&sortBy=highest+severity&filters[Show]=&filters[Integrations]=&filters[CollectionIds]=
## Licencia
Este proyecto está licenciado bajo la Licencia MIT