-
Notifications
You must be signed in to change notification settings - Fork 10
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
OZ-340: README as per Ozone's rebranding.
- Loading branch information
Showing
1 changed file
with
11 additions
and
59 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,62 +1,14 @@ | ||
| # Ozone EIP Client | ||
| <p align="center"> | ||
| <a href="https://docs.ozone-his.com/"><img src="https://raw.githubusercontent.com/ozone-his/.github/refs/heads/main/profile/ozone-logo.png" alt="Ozone" width="30%"/></a> | ||
| </p> | ||
|
|
||
| [](https://github.com/ozone-his/eip-client/actions/workflows/ci.yml) | ||
| <h3 align="center">The Instant HIS</h3> | ||
|
|
||
| A generic Spring Boot application designed for executing Apache Camel routes within Ozone. It can be used as a base image for building custom EIP clients. It has support for **_Java DSL_** and **_XML DSL_** routes. | ||
| <p align="center"> | ||
| Welcome to Ozone's open-source repositories! | ||
| <br/>Engage with the Ozone community and access useful resources below: | ||
| </p> | ||
|
|
||
| ## Getting Started | ||
|
|
||
| Follow the instructions below to get a copy of the project up and running on your local machine for development and testing purposes. | ||
|
|
||
| 1. **Clone the project** | ||
|
|
||
| ```bash | ||
| git clone https://github.com/ozone-his/eip-client.git | ||
| ``` | ||
| 2. **Build the project** | ||
|
|
||
| Navigate to the project directory and build the application using Maven: | ||
|
|
||
| ```bash | ||
| cd eip-client | ||
| mvn clean install | ||
| ``` | ||
| 3. **Run the app** | ||
|
|
||
| After building the project, you can run the application using the following command: | ||
|
|
||
| ```bash | ||
| java -jar app/target/eip-client-<version>.jar | ||
| ``` | ||
|
|
||
| ## Docker Support | ||
|
|
||
| ### Building a Docker image | ||
|
|
||
| ```bash | ||
| docker build . -t mekomsolutions/eip-client:latest | ||
| ``` | ||
|
|
||
| This image can now be consumed in a docker-compose.yml file with: | ||
|
|
||
| ```yaml | ||
| eip-client: | ||
| image: mekomsolutions/eip-client:latest | ||
| container_name: eip-client | ||
| volumes: | ||
| - "./path-to-your-configs:/config" | ||
| - "./path-to-your-routes:/routes" | ||
| - "./eip-home:/eip-home" | ||
| ports: | ||
| - "8083:8083" | ||
| ``` | ||
| ### Running the Docker image | ||
| ```bash | ||
| docker run -p 8083:8083 -v ./path-to-your-configs:/config -v ./path-to-your-routes:/routes mekomsolutions/eip-client:latest | ||
| ``` | ||
|
|
||
| ## License | ||
|
|
||
| This project is licensed under the Apache License 2.0 - see the [LICENSE](https://www.apache.org/licenses/LICENSE-2.0.txt) file for details. | ||
| <h3 align="center"> | ||
| <a href="https://docs.ozone-his.com/">Docs</a> • <a href="https://talk.openmrs.org/c/software/ozone-his/70">Forum</a> • <a href="https://openmrs.slack.com/archives/C02PYQD5D0A">Chat Room</a> | ||
| </h3> |