The backend part of MedTech Chain project. In particular, this repository contains the User Management Server, used to create, retrieve, update and delete researchers. In addition, authenticated researchers can perform queries on the Hyperledger Fabric Blockchain.
The application uses Java Spring Boot (version 3.2.2) and Spring Security (version 6.2.1). The required Java version is 21. Gradle is used as the build tool and for running other tasks (such as Checkstyle or tests). See build.gradle file for all dependencies.
Before building the application, make sure to copy the protobuf schema jar from the protos repository.
You have to clone this repo (if necessary) and run make javabindings command to build the jar.
See the README.md of the repository for further details.
Use the scripts/copy-protos.sh script to automatically copy the protobuf schema jar.
If you want to build the project in the command line, you can run:
gradle buildMake sure your Java version is set to the required one (i.e. 21). You can also use the Gradle Wrapper, for example:
# Linux/macOS
./gradlew build# Windows
\.gradlew.bat buildIf you want to build and run the application in IntelliJ IDEA, first open the project as a Gradle project
(NB! click on the build.gradle file and then press "Open", instead of clicking on the project root directory).
Change your Java version to the required one (i.e. 21). Go to File>Project Structure>Project Settings>Project>SDK
and select version 21 (maybe also do the same in File>Settings>Build, Execution, Deployment>Compiler>Java Compiler).
Set Gradle to the same version as Java JVM (File>Settings>Build, Execution, Deployment>Build Tools>Gradle,
select the project and set the JVM version next to Gradle JVM).
After completing the previous steps, you can use the Gradle plugin by clicking on the Gradle icon
(usually located on the right side of the IDE; you can reinstall the plugin if you cannot find it) and selecting the build task.
Alternatively, you can use IntelliJ's terminal and run the same build command as above (i.e. gradle build).
Before running the application, make sure to copy the crypto material required for the integration with Fabric infrastructure.
Use the scripts/copy-crypto.sh script to automatically copy the crypto material.
In case you want to run the backend for development purposes, you can run the application in the deps mode:
export SMTP_PASSWORD="" && docker-compose --profile deps -p medtechchain-ums-be up -d --buildOtherwise, you can also use the demo mode (see below).
In case you want to run the backend without the Blockchain,
you can set the environment variable gateway.mock to true in application.properties file.
If you want to enable HTTPS, you can set the environment variable server.ssl.enabled to true.
If needed, you can also change the port in server.port variable (e.g. to 8443 instead of 8088).
Note that currently a self-signed certificate is used (stored in the keystore directory),
which means that the browser will not trust it and will, most likely, fail to properly communicate with the backend server.
In order to run the blockchain infrastructure, go to tools repository which has to be present in the parent directory. Then run:
./infra-start.sh
./cc-deploy.shCheck tools for more instructions regarding running the infrastructure.
To run the application in the command line, type:
gradle bootRunYou can substitute gradle with./gradlew/\.gradlew.bat.
Navigate to src/main/java/nl/tudelft/medtechchain/Application.java,
right click on it and press Run 'Application'.
There are three profiles defined in the docker compose:
deps: run the backend application on host and run the database and development tools (e.g., smtp4dev, pgadmin4) in Dockerdev: run both backend application and its dependencies (database and development tools) in Dockerdemo: run both backend application and database only (no development tools) in Docker
When running the demo profile, make sure to provide the email app password.
export SMTP_PASSWORD="" && docker-compose --profile <deps|dev|demo> -p medtechchain-ums-be up -d --buildIf you want to inspect the database and perform queries by hand, access PGAdmin at
localhost:10000. Take the dummy credentials from the docker-compose.yaml for
authentication and setting up the database connection.
This is a testing SMTP server, having the interface accessible at localhost:11000.
Mind that the backend is configured by default to send emails here. If you want to send
real emails, please use the demo profile. Mind that when running demo profile, all volumes are deleted.
By default, the server is running on port 8088 (configured in application.properties file). See docs for the available API endpoints.
The admin details are also stored in application.properties file and can be configured. You are strongly encouraged to update the admin password and also the JWT secret key.
You can also run other Gradle tasks, both from command line and IntelliJ.
You can run Checkstyle (static code style analysis) as follows:
gradle checkstyleMain # The regular codebase
gradle checkstyleTest # The code in the test foldersYou can substitute gradle with./gradlew/\.gradlew.bat.
Running tests can be done tests as follows:
gradle testYou are free to substitute gradle with./gradlew/\.gradlew.bat.
If you want to use the Gradle plugin, click on the Gradle icon.
There you can find different tasks (e.g. checkstyleMain and chackstyleTest in the section other, and test in the verification section).
If you want to run the code coverage (either in the Command Line or in IntelliJ),
you have to first run the tests task, then jacocoTestCoverageVerification and then jacocoTestReport.
The coverage results can be found in build/reports/jacoco/html/index.html.
See build.gradle for configuration of the test coverage and excluded classes.
For other development information, such as GitHub Actions and an index of the available classes etc. see CONTRIBUTING.md file.