Skip to content

Commit

Permalink
refined tech documentation
Browse files Browse the repository at this point in the history
vondacho committed May 11, 2023
1 parent c47550c commit 476ad31
Showing 3 changed files with 14 additions and 3 deletions.
3 changes: 1 addition & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -15,10 +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).
- Play use cases with Postman using [this default collection](https://vondacho.github.io/arch-blueprint-java/postman/postman_collection.json) or with [Swagger UI](https://vondacho.github.io/arch-blueprint-java/api/).

## Technical documentation
- Powered by [MkDocs](https://www.mkdocs.org/getting-started/)
2 changes: 1 addition & 1 deletion src/doc/tech/index.md
Original file line number Diff line number Diff line change
@@ -17,7 +17,7 @@ CRUD operations on Customer entities exposed by a REST API.
- Build the project with `./gradlew clean build`.
- Start the database with `docker-compose up`.
- Launch the application with `./gradlew bootRun --args='--spring.profiles.active=test,jpa,postgres'`.
- Play use cases with Postman using [this default collection](https://vondacho.github.io/arch-blueprint-java/postman/postman_collection.json).
- Play use cases with Postman using [this default collection](https://vondacho.github.io/arch-blueprint-java/postman/postman_collection.json) or with [Swagger UI](https://vondacho.github.io/arch-blueprint-java/api/).

## This documentation
- Powered by [MkDocs](https://www.mkdocs.org/getting-started/)
12 changes: 12 additions & 0 deletions src/doc/tech/miscellaneous.md
Original file line number Diff line number Diff line change
@@ -10,3 +10,15 @@ View your local AppMap resources following [this tutorial](https://github.com/vo

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

## Test users

- `test / test` gives access to almost all endpoints but the delete and shutdown ones.
- `admin / admin` gives access to all functional and configured application management endpoints.

## Spring profiles

- `dev` defines credentials and access control for **test** and **admin** users.
- `test` defines credentials and access control for **anonymous**, **test** and **admin** users.
- `jpa` enables persistence with relational database using JPA interface.
- `postgres` configure datasource to use a local database running on port 5432.

0 comments on commit 476ad31

Please sign in to comment.