doc: Add "What's the demo for ?" section to the documentation
This commit is contained in:
37
README.md
37
README.md
@@ -1,32 +1,21 @@
|
|||||||
Event demo
|
Event Demo
|
||||||
==========
|
==========
|
||||||
- [Installation](#installation)
|
- [Installation](./doc/installation.md)
|
||||||
|
- [What's the demo for ?](#whats-the-demo-for-)
|
||||||
- [What's in this demo](#whats-in-this-demo)
|
- [What's in this demo](#whats-in-this-demo)
|
||||||
|
- [The stack](#the-stack)
|
||||||
|
|
||||||
|
|
||||||
Installation
|
What's the demo for ?
|
||||||
------------
|
--------------------
|
||||||
|
|
||||||
To run the stack:
|
This demo is intended to demonstrate the implementation
|
||||||
|
of different patterns and architectures.
|
||||||
|
|
||||||
```shell
|
- The Event sourcing pattern.
|
||||||
docker compose -f docker\docker-compose-prod.yaml -p event-demo up -d
|
- The Event driver pattern.
|
||||||
```
|
- The CQRS pattern.
|
||||||
|
- With the Hexagonal architecture.
|
||||||
Api url:
|
|
||||||
- [Backend API](http://api.traefik.me/)
|
|
||||||
- [Frontend web site](http://app.traefik.me/) (WIP)
|
|
||||||
|
|
||||||
Exposed url on test env:
|
|
||||||
- [PostgreSql](http://localhost:5432/)
|
|
||||||
- [Redis](http://localhost:6379/)
|
|
||||||
- [RabbitMQ](http://localhost:15672/)
|
|
||||||
|
|
||||||
Admin service URL:
|
|
||||||
- [Træfik dashboard](http://traefik.traefik.me/)
|
|
||||||
- [Redis insight](http://insight.redis.traefik.me/)
|
|
||||||
- [pgAdmin](http://pgadmin.postgresql.traefik.me/)
|
|
||||||
- [RabbitMQ management](http://management.rabbitmq.traefik.me/)
|
|
||||||
|
|
||||||
|
|
||||||
What's in this demo
|
What's in this demo
|
||||||
@@ -59,7 +48,7 @@ The stack
|
|||||||
Language
|
Language
|
||||||
- Kotlin
|
- Kotlin
|
||||||
|
|
||||||
Framwork
|
Framework
|
||||||
- Ktor
|
- Ktor
|
||||||
|
|
||||||
Database
|
Database
|
||||||
|
|||||||
23
doc/installation.md
Normal file
23
doc/installation.md
Normal file
@@ -0,0 +1,23 @@
|
|||||||
|
Installation
|
||||||
|
============
|
||||||
|
|
||||||
|
To run the stack:
|
||||||
|
|
||||||
|
```shell
|
||||||
|
docker compose -f docker\docker-compose-prod.yaml -p event-demo up -d
|
||||||
|
```
|
||||||
|
|
||||||
|
Api url:
|
||||||
|
- [Backend API](http://api.traefik.me/)
|
||||||
|
- [Frontend web site](http://app.traefik.me/) (WIP)
|
||||||
|
|
||||||
|
Exposed url on test env:
|
||||||
|
- [PostgreSql](http://localhost:5432/)
|
||||||
|
- [Redis](http://localhost:6379/)
|
||||||
|
- [RabbitMQ](http://localhost:15672/)
|
||||||
|
|
||||||
|
Admin service URL:
|
||||||
|
- [Træfik dashboard](http://traefik.traefik.me/)
|
||||||
|
- [Redis insight](http://insight.redis.traefik.me/)
|
||||||
|
- [pgAdmin](http://pgadmin.postgresql.traefik.me/)
|
||||||
|
- [RabbitMQ management](http://management.rabbitmq.traefik.me/)
|
||||||
Reference in New Issue
Block a user