Skip to content

Commit

Permalink
refined tech documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
vondacho committed May 11, 2023
1 parent 846468c commit c47550c
Show file tree
Hide file tree
Showing 4 changed files with 8 additions and 13 deletions.
1 change: 1 addition & 0 deletions src/doc/mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ nav:
- API: api/
- Architecture: architecture.md
- Testing: testing.md
- CI/CD: https://github.com/vondacho/arch-blueprint-java/actions
- Miscellaneous: miscellaneous.md

plugins:
Expand Down
7 changes: 1 addition & 6 deletions src/doc/tech/architecture.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,4 @@
# Architecture
![build workflow](https://github.com/vondacho/arch-blueprint-java/actions/workflows/build.yml/badge.svg)

A Java project as template and pedagogical support for the teaching of Clean Architecture crafting practice.

## C4
- [System context](https://www.structurizr.com/share/38199/diagrams#blueprint-context)
Expand All @@ -13,6 +10,7 @@ Start the AppMap viewer on local port 3000 with
`docker run -it -p 3000:8080 ghcr.io/vondacho/appmap-viewer:latest`.

Then, visualize the behaviour of main use cases from the browser

- [E2E from API layer](http://localhost:3000/appmap/appmap.html?appmap=https://vondacho.github.io/arch-blueprint-java/appmap/edu_obya_blueprint_customer_adapter_rest_CustomerEndpointIT_shouldCreateAndModifyAndDeleteCustomer.appmap.json)
- [E2E from Service layer](http://localhost:3000/appmap/appmap.html?appmap=https://vondacho.github.io/arch-blueprint-java/appmap/edu_obya_blueprint_customer_application_CustomerServiceIT_shouldCreateAndFindAndModifyAndRemoveACustomer.appmap.json)
- [E2E from Data layer](http://localhost:3000/appmap/appmap.html?appmap=https://vondacho.github.io/arch-blueprint-java/appmap/edu_obya_blueprint_customer_adapter_jpa_CustomerRepositoryIT_shouldCreateAndFindAndModifyAndRemoveACustomer.appmap.json)
Expand All @@ -32,6 +30,3 @@ ACL is used to protect the internal ubiquitous language from external languages.

## Data model
![Data model](../uml/data-model.svg)

## CI/CD
[Github actions](https://github.com/vondacho/arch-blueprint-java/actions)
6 changes: 1 addition & 5 deletions src/doc/tech/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,13 +15,9 @@ CRUD operations on Customer entities exposed by a REST API.

## Getting started
- Build the project with `./gradlew clean build`.
- Launch the tests suite with `./gradlew clean check`.
- Start the database with `docker-compose up`.
- Launch the application with `./gradlew bootRun --args='--spring.profiles.active=test,jpa,postgres'`.
- Play use cases in Postman using [this default Postman collection](https://vondacho.github.io/arch-blueprint-java/postman/postman_collection.json).

## Release
Draft new release of the application from GitHub [release panel](https://github.com/vondacho/arch-blueprint-java/releases).
- Play use cases with Postman using [this default collection](https://vondacho.github.io/arch-blueprint-java/postman/postman_collection.json).

## This documentation
- Powered by [MkDocs](https://www.mkdocs.org/getting-started/)
Expand Down
7 changes: 5 additions & 2 deletions src/doc/tech/miscellaneous.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,12 @@
# Miscellaneous

## Technical documentation
## This documentation
Build technical documentation with `./gradlew allureAggregateReport plantumlAll generateSwaggerUI mkdocsBuild`.

## AppMap resources
Generate AppMap resources with `./gradlew appmap test`.

View your local AppMap resources following [this tutorial](https://github.com/vondacho/appmap-viewer#getting-started).
View your local AppMap resources following [this tutorial](https://github.com/vondacho/appmap-viewer#getting-started).

## Release
Draft new release of the application from GitHub [release panel](https://github.com/vondacho/arch-blueprint-java/releases).

0 comments on commit c47550c

Please sign in to comment.