https://github.com/achique-luisdan/api-cakes-shop
API Rest de Tienda online de Tortas
https://github.com/achique-luisdan/api-cakes-shop
backend express jest nodejs sql supertest typeorm typescript unit-tests
Last synced: 4 months ago
JSON representation
API Rest de Tienda online de Tortas
- Host: GitHub
- URL: https://github.com/achique-luisdan/api-cakes-shop
- Owner: achique-luisdan
- Created: 2023-01-26T23:34:05.000Z (almost 3 years ago)
- Default Branch: master
- Last Pushed: 2023-02-05T04:32:37.000Z (almost 3 years ago)
- Last Synced: 2025-04-08T05:35:55.957Z (8 months ago)
- Topics: backend, express, jest, nodejs, sql, supertest, typeorm, typescript, unit-tests
- Language: TypeScript
- Homepage:
- Size: 273 KB
- Stars: 5
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# API Cakes Shop
Tienda online de Tortas
## Características (Features) ❤️
:two_hearts: Landing page con hero vistoso *(frontend)*
:two_hearts: Catálogo de productos
:two_hearts: Promociones con descuento
:two_hearts: Creación de pedidos
## Instalación (Install) 🔧
Para instalar las herramientas necesarias:
### Paso 1. Instalar Node.js
Acceder al sitio oficial de [Node.js](https://nodejs.org/), descargar e instalar.
* [Node JS v16 o superior](https://nodejs.org/) - Entorno de Ejecución de Servidor para JavaScript
### Paso 2. Instalar dependencias del proyecto
Accede a la carpeta del proyecto y ejecuta el siguiente comando:
```
npm install
```
Serán instaladas las siguientes dependencias:
:hammer_and_wrench: [Express.js v4.18.2](https://expressjs.com/)
:hammer_and_wrench: [TypeScript v4.9.4](https://www.typescriptlang.org/)
:hammer_and_wrench: [TypeORM v0.3.11](https://typeorm.io/)
:hammer_and_wrench: [SQLite3 v5.1.4](https://www.npmjs.com/package/sqlite3)
:hammer_and_wrench: [CORS v2.8.5](https://www.npmjs.com/package/cors)
### Paso 3. Compilar proyecto
```
npm run build
```
### Paso 4. Levantar servidor de desarrollo
```
npm run start
```
### Paso 5. Explorar endpoints API
#### Consultar promociones
> GET [/api/promotions](http://localhost:3000/api/promotions)
#### Consultar productos
> GET [/api/products](http://localhost:3000/api/products)
#### Crear pedido
> POST [/api/orders](http://localhost:3000/api/orders)
> *Request:*
```json
{
"items": [
{
"productId": 1,
"quantity": 12
}
]
}
```
#### Crear promociones:
> POST [/api/promotions](http://localhost:3000/api/promotions)
> *Request:*
```json
[
{
"id": 1,
"name": "Jueves de feria",
"discount": 50,
"isActive": true
},
{
"id": 2,
"name": "Martes en familia",
"discount": 20,
"isActive": true
}
]
```
#### Crear productos
> POST [/api/products](http://localhost:3000/api/products)
> *Request:*
```json
[
{
"name": "Tarta mousse de chocolate y baileys",
"price": 12,
"image": "https://images.pexels.com/photos/4110003/pexels-photo-4110003.jpeg?auto=compress&cs=tinysrgb&w=1260&h=750&dpr=1"
},
{
"name": "Tarta de fresas con crema de vainilla",
"price": 6,
"image": "https://images.pexels.com/photos/12846488/pexels-photo-12846488.jpeg?auto=compress&cs=tinysrgb&w=1260&h=750&dpr=1"
},
{
"name": "Cheesecake de Nutella",
"price": 19,
"image": "https://images.pexels.com/photos/15031855/pexels-photo-15031855.jpeg?auto=compress&cs=tinysrgb&w=600"
}
]
```
## Pruebas unitarias (Unit tests) 💋
```
npm run test
```
✅ Crea nuevos productos
✅ Crea nuevas promociones
✅ Asocia promociones a productos
✅ Si producto tiene varias promociones, indica la promoción con mayor descuento
✅ Si promociones asociadas a un producto tienen mismo descuento, selecciona la primera
✅ Si promoción desactivada esta asociada a un producto, no mostrar promoción
✅ Calcula precio de producto con descuento por cada promoción
✅ Crea nuevo pedido
## Base de datos (Database) :floppy_disk:
### Modelo Lógico Relacional
## Mejora Continua 🚀
:two_hearts: Emitir comprobante de pedido