Skip to content

Commit 70243a5

Browse files
authored
Merge pull request #293 from gvolpe/docs/components-graphic
Add components illustration
2 parents 29dd028 + c41a578 commit 70243a5

File tree

2 files changed

+14
-2
lines changed

2 files changed

+14
-2
lines changed

README.md

+14-2
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,22 @@ shopping-cart
77

88
⚠️ **IMPORTANT NOTICE** If you come here from [Practical FP in Scala](https://leanpub.com/pfp-scala), go to the [master](https://github.com/gvolpe/pfps-shopping-cart/tree/master) branch. You're now on the `second-edition` branch, which is the new default, as I'm currently working on the 2nd edition of the book. ⚠️
99

10+
## Components Overview
11+
12+
Here's an overview of the different components that make this application.
13+
14+
[!components](./components.png)
15+
16+
- Both **Services** and **Authentication** are *algebras*. The latter are mainly dependencies for some of the services.
17+
- Programs shows **Checkout**, the business logic that combines most of the services.
18+
- Effects show our custom interfaces required implicitly.
19+
- The lines connecting services to Redis and PostgreSQL show which ones access which storage.
20+
- The HTTP layer shows the client and the different routes.
21+
- At the very end, we have both the modules and the entry point to the application.
22+
1023
## Authentication Data
1124

12-
For didactic purposes this information is made available to the readers but in a real application *THIS SHOULD NEVER BE MADE PUBLIC*.
25+
For didactic purposes, this is made available to the readers but in a real application *THIS SHOULD NEVER BE MADE PUBLIC*.
1326

1427
For Admin users, the following environment variables are needed:
1528

@@ -60,7 +73,6 @@ sbt test
6073

6174
To run Integration Tests we need to run both `PostgreSQL` and `Redis`:
6275

63-
6476
```
6577
docker-compose up
6678
sbt it:test

components.png

75.1 KB
Loading

0 commit comments

Comments
 (0)