Skip to content

Commit 543d4f0

Browse files
chore: update readme with sonarcloud badges and usage section
1 parent afccd14 commit 543d4f0

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

README.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,23 @@
44
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg?style=plastic)](https://opensource.org/licenses/MIT)
55
![Version](https://img.shields.io/github/v/release/smartoperatingblock/user-management-integration-microservice?style=plastic)
66

7+
[![Code Smells](https://sonarcloud.io/api/project_badges/measure?project=SmartOperatingBlock_user-management-integration-microservice&metric=code_smells)](https://sonarcloud.io/summary/new_code?id=SmartOperatingBlock_user-management-integration-microservice)
8+
[![Bugs](https://sonarcloud.io/api/project_badges/measure?project=SmartOperatingBlock_user-management-integration-microservice&metric=bugs)](https://sonarcloud.io/summary/new_code?id=SmartOperatingBlock_user-management-integration-microservice)
9+
[![Vulnerabilities](https://sonarcloud.io/api/project_badges/measure?project=SmartOperatingBlock_user-management-integration-microservice&metric=vulnerabilities)](https://sonarcloud.io/summary/new_code?id=SmartOperatingBlock_user-management-integration-microservice)
10+
[![Duplicated Lines (%)](https://sonarcloud.io/api/project_badges/measure?project=SmartOperatingBlock_user-management-integration-microservice&metric=duplicated_lines_density)](https://sonarcloud.io/summary/new_code?id=SmartOperatingBlock_user-management-integration-microservice)
11+
712
An integration microservice responsible to manage Operating Block users:
813
- User Authentication
914
- Health Professionals Digital Twins creation
1015
- Health Professionals information system
16+
17+
## Usage
18+
1. Provide a `.env` file with the following variables:
19+
- USER_MANAGEMENT_MONGODB_URL
20+
2. Run the container with the command:
21+
22+
`docker run ghcr.io/smartoperatingblock/user-management-integration-microservice:latest`
23+
24+
## Documentation
25+
- Check out the *Rest API* [here](https://smartoperatingblock.github.io/user-management-integration-microservice/documentation/openapi-doc)
26+
- Check out the *Code documentation* [here](https://smartoperatingblock.github.io/user-management-integration-microservice/documentation/code-doc)

0 commit comments

Comments
 (0)