https://github.com/marlonperez-01/calcularfacturaelectrica

API REST para calcular costo de la factura eléctrica.
https://github.com/marlonperez-01/calcularfacturaelectrica

Last synced: 2 days ago
JSON representation

API REST para calcular costo de la factura eléctrica.

• Host: GitHub
• URL: https://github.com/marlonperez-01/calcularfacturaelectrica
• Owner: MarlonPerez-01
• Created: 2021-11-12T21:25:18.000Z (about 3 years ago)
• Default Branch: master
• Last Pushed: 2021-11-12T21:26:30.000Z (about 3 years ago)
• Last Synced: 2024-04-25T04:32:25.160Z (10 months ago)
• Language: TypeScript
• Size: 70.3 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# API REST para auditar factura eléctrica y visualizar dashboard.

API REST encargada de realizar los cargos necesarios para calcular y auditar el costo de una factura eléctrica de pequeña demanda tanto para uso general como para uso residencial. También permite obtener las facturas de un usuario, ingresarlas a la base de datos. Algunas rutas se encuentran protegidas para que solo el administrador sea capaz de llamar el endpoint.

## Empezando

### Dependencias

* [Mysql](https://www.mysql.com/)

* [NodeJS](https://nodejs.org/en/)

### Configuración

* Clonar este repositorio

```sh

git clone https://github.com/MarlonPerez-01/CalcularFacturaElectrica.git

```

* Navegar  al directorio del proyecto

* Ejecutar `npm install` o `npm i` para la instalación de dependencias.

* Crear el archivo `.env` y copiar el contenido del archivo `.env.sample` y asignar los valores a cada variable.

* Crear la base de datos en MySQL e insertar datos utilizando el archivo `db-data.sql` que se encuentra en la carpeta data.

> Usuarios de prueba

>

> | NIC    | Correo            | Contraseñan | Privilegios |

> | ------ | ----------------- | ----------- | ----------- |

> | 654321 | `[email protected]` | `pass`      | Admin       |

> | 123456 | `[email protected]`   | `pass`      | Usuario     |

### Ejecutar

* Ejecutar `npm run dev` para iniciar la aplicación.

## Estructura del proyecto

    .

    ├── ...

    │   ├── src                         # Dentro se encuentran los ficheros fuentes

    │   ├── config                      # Configuración y conexión a la base de datos

    │   ├── constant                    # Constantes

    │   ├── controllers                 # Controladores

    │   ├── data                        # Archivo sql para la creación de la base de datos e inserción de datos

    │   ├── exceptions                  # Extiende error http

    │   ├── functions                   # Funciones para calcular costo de la factura

    │   ├── helpers                     # Funciones para resolver tareas específicas

    │   ├── middlewares                 # Middlewares

    │   ├── models                      # Queries a la base de datos

    │   ├── routes                      # Rutas de la API

    │   ├── types                       # Definición de tipado

    │   ├── validators                  # Validaciones

    │   └── app.ts                      # Llamadas a las funciones principales

    ├── .env                            # Fichero de variables de entorno

    ├── .env.sample                     # Fichero de variables de entorno de ejemplo

    ├── .gitignore                      # Fichero para ignorar archivos en github

    ├── .prettierrc                     # Configuración del formato de código

    ├── package-lock.json               # Mantener versión de cada paquete

    ├── package.json                    # Información del proyecto, scripts y dependencias

    ├── README.md                       # Documentación

    ├── tsconfig.json                   # Configuración de typescript

    └── ...

## Endpoints

### GET

`/facturas/:id`\

`/pequenia-demanda`\

`/pliegos`

### POST

`/auth/login`\

`/auth/signup`\

`/distribuidores`\

`/facturas`\

`/pequenia-demanda`