https://github.com/matgalv2/shop-app

Simple CRUD REST-based application for managing online store. Database consists of 5 tables: clients, products, orders, addresses and ordersproducts, which resolves N:N relation between those two.
https://github.com/matgalv2/shop-app

cats flyway http4s openapi postgresql rest-api scala zio

Last synced: 5 months ago
JSON representation

Simple CRUD REST-based application for managing online store. Database consists of 5 tables: clients, products, orders, addresses and ordersproducts, which resolves N:N relation between those two.

• Host: GitHub
• URL: https://github.com/matgalv2/shop-app
• Owner: matgalv2
• Created: 2024-09-16T14:56:09.000Z (over 1 year ago)
• Default Branch: master
• Last Pushed: 2024-12-14T21:21:44.000Z (over 1 year ago)
• Last Synced: 2025-01-06T03:41:32.486Z (about 1 year ago)
• Topics: cats, flyway, http4s, openapi, postgresql, rest-api, scala, zio
• Language: Scala
• Homepage:
• Size: 352 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: readme.md

Awesome Lists containing this project

README

          
# Shop app

Simple CRUD REST-based application for managing online store. Database consists of 5 tables: clients, products, orders, addresses and ordersproducts, which resolves N:N relation between those two.

![image info](./icon.png)

### Progress

![](https://geps.dev/progress/100?dangerColor=800000&warningColor=ff9900&successColor=006600)

|                   | Customers | Products | Orders |

|-------------------|-----------|----------|--------|

| Implementation    | ✅         | ✅        | ✅      |

| Unit Tests        | ✅         | ✅        | ✅      |

| Integration Tests | ✅         | ✅        | ✅      |

| Acceptance Tests  | ✅         | ✅        | ✅      |

## Technology & tools:

Technology stack:

* Scala 2.13

* ZIO 2

* PostgreSQL

* Flyway

* Http4s

* Cats 2

* OpenAPI

* Kafka

Tools & libraries:

* Guardrail

* Quill

* Chimney

* Typesafe config

* Docker

## API

All APIs are described here:

* [Customers API](./api/customerApi.yaml)

* [Products API](./api/productApi.yaml)

* [Orders API]()

## Design decisions:

### 1. REST API

* Based on OpenApi specifications Guardrail generates boilerplate code for controllers.

### 2. Database

* Database migrations - to ensure application works with latest version of database Flyway controls database migrations.

* DSL - to simplify work with database Quill provides QDSL for expressing queries in Scala.

* Queries implementations - due to fact that quill queries return effects that can fail with SQLError all effects should die with DatabaseCriticalFailure.

* Audit table - to allow monitoring changes in orders table audit table has been utilized. Any change in orders table triggers trigger which saves modification in orders_aud table.

* Indexes - due to the fact that sooner or later orders_aud will become large in size hash and btree indexes were added to simplify queries using this table.

### 3. Data transformation

* Mappers - Chimney library was utilized for transforming data types (Domain <-> DTO).

### 4. Domain

* Validation - to ensure all data flowing through app is valid, all the objects are validated before being used. 

* ErrorMessage - special type class for all domain errors to easily transform them into error responses.

### 5. Data flow

* To allow fetching reasonable number of some type of data all repositories supports fetching with offset and limit.

### 6. Automation

* Cyclic jobs - side tasks that must be done in specified intervals like archiving delivered orders after 3 months.

### 7. Asynchronous processing

* Message Broker - some time-consuming operations should be nonblocking that is why Kafka was utilized to process order requests.