HiCare is a comprehensive personalized healthcare solution that harnesses the power of microservices, patient data, genomics, and artificial intelligence (AI) to revolutionize the way healthcare is delivered. This platform enables the development of tailored treatment plans, remote monitoring, health tracking, and preventive care for individuals.
In the era of personalized medicine, healthcare solutions need to cater to the unique needs of individuals. HiCare addresses this challenge by leveraging microservices, patient data, genomics, and AI to provide personalized treatment plans, remote monitoring, health tracking, and preventive care.
With HiCare, healthcare providers can access a wealth of patient data, including medical records, genetic information, lifestyle choices, and real-time health monitoring. This data is analyzed using AI algorithms to generate insights and recommendations, allowing healthcare professionals to make informed decisions and deliver tailored healthcare solutions.
Personalized Treatment Plans: HiCare creates customized treatment plans for patients based on their unique health conditions, medical history, and genetic profile. These plans consider individual factors such as allergies, drug interactions, and lifestyle choices, ensuring optimal care.
Remote Monitoring: HiCare enables remote monitoring of patients’ vital signs and health parameters using wearable devices or IoT sensors. This feature allows healthcare providers to track patient progress, detect early warning signs, and intervene when necessary, regardless of geographical constraints.
Health Tracking: Users can utilize the HiCare mobile application or web interface to monitor their health and wellness. The platform supports the tracking of activities, sleep patterns, nutrition, medication adherence, and other relevant health metrics, providing individuals with insights into their well-being.
Preventive Care: By analyzing patient data and genetic information, HiCare identifies potential health risks and provides proactive recommendations for preventive care. This feature helps individuals take preventive measures to mitigate the risk of developing certain conditions or diseases.
The HiCare platform is built on a microservices architecture, which offers scalability, flexibility, and modularity. The architecture consists of the following components:
User Interface (UI): The UI provides a user-friendly interface for patients, healthcare professionals, and administrators to interact with the platform. It enables users to access health data, view recommendations, and manage their healthcare profiles.
Authentication and Authorization: This component handles user authentication and authorization, ensuring secure access to the HiCare platform and protecting sensitive patient information.
Patient Data Management: The patient data management microservice stores and manages patient data, including medical records, lab results, genetic profiles, and lifestyle information. It ensures data integrity, confidentiality, and compliance with privacy regulations.
AI and Analytics: This microservice utilizes AI algorithms and data analytics techniques to process and analyze patient data. It generates actionable insights, personalized recommendations, and predictive models to support healthcare decision-making.
Remote Monitoring Integration: This component integrates with wearable devices, IoT sensors, and other remote monitoring solutions to collect real-time health data from patients. It ensures seamless data transmission and enables continuous monitoring of patient health.
External Services Integration: The HiCare platform can integrate with external services such as electronic health record systems, laboratory systems, and genetic testing providers. This integration allows for seamless data exchange and interoperability.
Microservices: HiCare is built using a microservices architecture, leveraging the benefits of modularity, scalability, and fault isolation.
Containerization: Docker is used for containerization, enabling easy deployment and management of microservices.
API Gateway: An API gateway is employed to provide a unified entry point for accessing the different microservices within the HiCare platform.
Front-end: The user interface is developed using modern web technologies such as React.js and HTML/CSS, providing an intuitive and responsive experience.
Back-end: The back-end microservices are developed using technologies such as Node.js, Python, or Java, depending on the specific requirements of each service.
Data Storage: HiCare utilizes robust and scalable databases, such as PostgreSQL or MongoDB, to store patient data, configuration information, and other relevant data.
AI and Analytics: Machine learning and AI algorithms, implemented using frameworks like TensorFlow or PyTorch, are used for data analysis, predictive modeling, and generating personalized recommendations.
Security: The platform incorporates robust security measures, including encryption, secure communication protocols (e.g., HTTPS), and access control mechanisms to safeguard patient data and ensure compliance with privacy regulations.
To get started with HiCare, follow these steps:
Clone the HiCare repository from GitHub.
Install the necessary dependencies for each microservice by following the provided documentation.
Configure the required environment variables for each microservice, including database connections, API keys, and security settings.
Build and deploy each microservice using the provided deployment scripts or Docker containers.
Set up the API gateway and configure routing rules to direct requests to the appropriate microservices.
Launch the user interface and ensure it can communicate with the microservices correctly.
For more detailed instructions, please refer to the documentation provided in the repository.
Once HiCare is set up and running, the platform can be used for various purposes, including:
Patients can access the HiCare mobile application or web interface to monitor their health, view treatment plans, track progress, and receive personalized recommendations.
Healthcare professionals can utilize the platform to access patient records, review treatment plans, monitor vital signs, and communicate with patients remotely.
Administrators can manage user accounts, configure system settings, and monitor the overall performance and usage of the HiCare platform.
We welcome contributions to HiCare! If you’re interested in contributing, please follow the guidelines outlined in the CONTRIBUTING.md file in the HiCare repository.
HiCare is released under the MIT License. Feel free to use, modify, and distribute the software in accordance with the license terms.
Node is required for generation and recommended for development. package.json is always generated for a better development experience with prettier, commit hooks, scripts and so on.
In the project root, JHipster generates configuration files for tools like git, prettier, eslint, husky, and others that are well known and you can find references in the web.
/src/* structure follows default Java structure.
.yo-rc.json - Yeoman configuration file
JHipster configuration is stored in this file at generator-jhipster key. You may find generator-jhipster-* for specific blueprints configuration..yo-resolve (optional) - Yeoman conflict resolver
Allows to use a specific action when conflicts are found skipping prompts for files that matches a pattern. Each line should match [pattern] [action] with pattern been a Minimatch pattern and action been one of skip (default if ommited) or force. Lines starting with # are considered comments and are ignored..jhipster/*.json - JHipster entity configuration files
npmw - wrapper to use locally installed npm.
JHipster installs Node and npm locally using the build tool by default. This wrapper makes sure npm is installed locally and uses it avoiding some differences different versions can cause. By using ./npmw instead of the traditional npm you can configure a Node-less environment to develop or test your application./src/main/docker - Docker configurations for the application and services that the application depends onBefore you can build this project, you must install and configure the following dependencies on your machine:
After installing Node, you should be able to run the following command to install development tools. You will only need to run this command when dependencies change in package.json.
npm install
We use npm scripts and Angular CLI with Webpack as our build system.
Run the following commands in two separate terminals to create a blissful development experience where your browser auto-refreshes when files change on your hard drive.
./mvnw
npm start
Npm is also used to manage CSS and JavaScript dependencies used in this application. You can upgrade dependencies by
specifying a newer version in package.json. You can also run npm update and npm install to manage dependencies.
Add the help flag on any command to see how you can use it. For example, npm help update.
The npm run command will list all of the scripts available to run for this project.
JHipster ships with PWA (Progressive Web App) support, and it’s turned off by default. One of the main components of a PWA is a service worker.
The service worker initialization code is disabled by default. To enable it, uncomment the following code in src/main/webapp/app/app.module.ts:
ServiceWorkerModule.register('ngsw-worker.js', { enabled: false }),
For example, to add Leaflet library as a runtime dependency of your application, you would run following command:
npm install --save --save-exact leaflet
To benefit from TypeScript type definitions from DefinitelyTyped repository in development, you would run following command:
npm install --save-dev --save-exact @types/leaflet
Then you would import the JS and CSS files specified in library’s installation instructions so that Webpack knows about them: Edit src/main/webapp/app/app.module.ts file:
import 'leaflet/dist/leaflet.js';
Edit src/main/webapp/content/scss/vendor.scss file:
@import 'leaflet/dist/leaflet.css';
Note: There are still a few other things remaining to do for Leaflet that we won’t detail here.
For further instructions on how to develop with JHipster, have a look at Using JHipster in development.
Microservices doesn’t contain every required backend feature to allow microfrontends to run alone. You must start a pre-built gateway version or from source.
Start gateway from source:
cd gateway
npm run docker:db:up # start database if necessary
npm run docker:others:up # start service discovery and authentication service if necessary
npm run app:start # alias for ./(mvnw|gradlew)
Microfrontend’s build-watch script is configured to watch and compile microfrontend’s sources and synchronizes with gateway’s frontend.
Start it using:
cd microfrontend
npm run docker:db:up # start database if necessary
npm run build-watch
It’s possible to run microfrontend’s frontend standalone using:
cd microfrontend
npm run docker:db:up # start database if necessary
npm watch # alias for `npm start` and `npm run backend:start` in parallel
You can also use Angular CLI to generate some custom client code.
For example, the following command:
ng generate component my-component
will generate few files:
create src/main/webapp/app/my-component/my-component.component.html
create src/main/webapp/app/my-component/my-component.component.ts
update src/main/webapp/app/app.module.ts
JHipster Control Center can help you manage and control your application(s). You can start a local control center server (accessible on http://localhost:7419) with:
docker compose -f src/main/docker/jhipster-control-center.yml up
Congratulations! You’ve selected an excellent way to secure your JHipster application. If you’re not sure what OAuth and OpenID Connect (OIDC) are, please see What the Heck is OAuth?
To log in to your app, you’ll need to have Keycloak up and running. The JHipster Team has created a Docker container for you that has the default users and roles. Start Keycloak using the following command.
docker compose -f src/main/docker/keycloak.yml up
The security settings in src/main/resources/config/application.yml are configured for this image.
spring:
...
security:
oauth2:
client:
provider:
oidc:
issuer-uri: http://localhost:9080/realms/jhipster
registration:
oidc:
client-id: web_app
client-secret: web_app
scope: openid,profile,email
Some of Keycloak configuration is now done in build time and the other part before running the app, here is the list of all build and configuration options.
Before moving to production, please make sure to follow this guide for better security and performance.
Also, you should never use start-dev nor KC_DB=dev-file in production.
When using Kubernetes, importing should be done using init-containers (with a volume when using db=dev-file).
If you’d like to use Okta instead of Keycloak, it’s pretty quick using the Okta CLI. After you’ve installed it, run:
okta register
Then, in your JHipster app’s directory, run okta apps create and select JHipster. This will set up an Okta app for you, create ROLE_ADMIN and ROLE_USER groups, create a .okta.env file with your Okta settings, and configure a groups claim in your ID token.
Run source .okta.env and start your app with Maven or Gradle. You should be able to sign in with the credentials you registered with.
If you’re on Windows, you should install WSL so the source command will work.
If you’d like to configure things manually through the Okta developer console, see the instructions below.
First, you’ll need to create a free developer account at https://developer.okta.com/signup/. After doing so, you’ll get your own Okta domain, that has a name like https://dev-123456.okta.com.
Modify src/main/resources/config/application.yml to use your Okta settings.
spring:
...
security:
oauth2:
client:
provider:
oidc:
issuer-uri: https://{yourOktaDomain}/oauth2/default
registration:
oidc:
client-id: {clientId}
client-secret: {clientSecret}
security:
Create an OIDC App in Okta to get a {clientId} and {clientSecret}. To do this, log in to your Okta Developer account and navigate to Applications > Add Application. Click Web and click the Next button. Give the app a name you’ll remember, specify http://localhost:8080 as a Base URI, and http://localhost:8080/login/oauth2/code/oidc as a Login Redirect URI. Click Done, then Edit and add http://localhost:8080 as a Logout redirect URI. Copy and paste the client ID and secret into your application.yml file.
Create a ROLE_ADMIN and ROLE_USER group and add users into them. Modify e2e tests to use this account when running integration tests. You’ll need to change credentials in src/test/javascript/e2e/account/account.spec.ts and src/test/javascript/e2e/admin/administration.spec.ts.
Navigate to API > Authorization Servers, click the Authorization Servers tab and edit the default one. Click the Claims tab and Add Claim. Name it “groups”, and include it in the ID Token. Set the value type to “Groups” and set the filter to be a Regex of .*.
After making these changes, you should be good to go! If you have any issues, please post them to Stack Overflow. Make sure to tag your question with “jhipster” and “okta”.
If you’d like to use Auth0 instead of Keycloak, follow the configuration steps below:
dev-xxx.us.auth0.comRegular Web Applications. Switch to the Settings tab, and configure your application settings like:
http://localhost:8080/login/oauth2/code/oidchttp://localhost:8080/ROLE_ADMIN, and ROLE_USER.Empty rule template. Provide a meaningful name like JHipster claims and replace Script content with the following and Save.function (user, context, callback) {
user.preferred_username = user.email;
const roles = (context.authorization || {}).roles;
function prepareCustomClaimKey(claim) {
return `https://www.jhipster.tech/${claim}`;
}
const rolesClaim = prepareCustomClaimKey('roles');
if (context.idToken) {
context.idToken[rolesClaim] = roles;
}
if (context.accessToken) {
context.accessToken[rolesClaim] = roles;
}
callback(null, user, context);
}
JHipster application, modify src/main/resources/config/application.yml to use your Auth0 application settings:spring:
...
security:
oauth2:
client:
provider:
oidc:
# make sure to include the ending slash!
issuer-uri: https://{your-auth0-domain}/
registration:
oidc:
client-id: {clientId}
client-secret: {clientSecret}
scope: openid,profile,email
jhipster:
...
security:
oauth2:
audience:
- https://{your-auth0-domain}/api/v2/
OpenAPI-Generator is configured for this application. You can generate API code from the src/main/resources/swagger/api.yml definition file by running:
./mvnw generate-sources
Then implements the generated delegate classes with @Service classes.
To edit the api.yml definition file, you can use a tool such as Swagger-Editor. Start a local instance of the swagger-editor using docker by running: docker compose -f src/main/docker/swagger-editor.yml up -d. The editor will then be reachable at http://localhost:7742.
Refer to Doing API-First development for more details.
To build the final jar and optimize the Hicare application for production, run:
./mvnw -Pprod clean verify
This will concatenate and minify the client CSS and JavaScript files. It will also modify index.html so it references these new files.
To ensure everything worked, run:
java -jar target/*.jar
Then navigate to http://localhost:8081 in your browser.
Refer to Using JHipster in production for more details.
To package your application as a war in order to deploy it to an application server, run:
./mvnw -Pprod,war clean verify
To launch your application’s tests, run:
./mvnw verify
Unit tests are run by Jest. They’re located in src/test/javascript/ and can be run with:
npm test
Performance tests are run by Gatling and written in Scala. They’re located in src/test/java/gatling/simulations.
You can execute all Gatling tests with
./mvnw gatling:test
For more information, refer to the Running tests page.
Sonar is used to analyse code quality. You can start a local Sonar server (accessible on http://localhost:9001) with:
docker compose -f src/main/docker/sonar.yml up -d
Note: we have turned off forced authentication redirect for UI in src/main/docker/sonar.yml for out of the box experience while trying out SonarQube, for real use cases turn it back on.
You can run a Sonar analysis with using the sonar-scanner or by using the maven plugin.
Then, run a Sonar analysis:
./mvnw -Pprod clean verify sonar:sonar -Dsonar.login=admin -Dsonar.password=admin
If you need to re-run the Sonar phase, please be sure to specify at least the initialize phase since Sonar properties are loaded from the sonar-project.properties file.
./mvnw initialize sonar:sonar -Dsonar.login=admin -Dsonar.password=admin
Additionally, Instead of passing sonar.password and sonar.login as CLI arguments, these parameters can be configured from sonar-project.properties as shown below:
sonar.login=admin
sonar.password=admin
For more information, refer to the Code quality page.
You can use Docker to improve your JHipster development experience. A number of docker-compose configuration are available in the src/main/docker folder to launch required third party services.
For example, to start a oracle database in a docker container, run:
docker compose -f src/main/docker/oracle.yml up -d
To stop it and remove the container, run:
docker compose -f src/main/docker/oracle.yml down
You can also fully dockerize your application and all the services that it depends on. To achieve this, first build a docker image of your app by running:
npm run java:docker
Or build a arm64 docker image when using an arm64 processor os like MacOS with M1 processor family running:
npm run java:docker:arm64
Then run:
docker compose -f src/main/docker/app.yml up -d
When running Docker Desktop on MacOS Big Sur or later, consider enabling experimental Use the new Virtualization framework for better processing performance (disk access performance is worse).
For more information refer to Using Docker and Docker-Compose, this page also contains information on the docker-compose sub-generator (jhipster docker-compose), which is able to generate docker configurations for one or several JHipster applications.
To configure CI for your project, run the ci-cd sub-generator (jhipster ci-cd), this will let you generate configuration files for a number of Continuous Integration systems. Consult the Setting up Continuous Integration page for more information.