Web service intended to provide operations on documents (create, edit, fetch document's data and generate file in docx format by template)
Application can be used for creating and editing document's data with possibility to generate final DocX-document by template
mvnw clean install spring-boot:repackage -Pnon_module_java,test-jar,xsd -DskipTests
to build image to Docker daemon:
mvnw clean install -Pnon_module_java,test-jar,xsd,jib -DskipTests
mvnw clean install spring-boot:repackage -Pmodule_java,test-jar,xsd,jib -DskipTests
building image to Docker daemon:
mvnw clean package -Pmodule_java,test-jar,xsd,jib -DskipTests
buidling and deploying docker image to DockerHub:
mvnw -s settings.xml clean package -Pmodule_java,test-jar,xsd,jib -DskipTests -Denv.DOCKERHUB_USERNAME=<username> -Denv.DOCKERHUB_PASSWORD=<password>
run local build/deployment process:
skaffold config set --global local-cluster true
skaffold dev --trigger notify
In order to run the ws-documents
service using skaffold, you need to have the DocumentDB up and running:
skaffold run -p documents-db-local
skaffold run -p local
Run PostgreSQL in docker-container via command:
docker run --name db-postgres -e POSTGRES_USER=postgres -e POSTGRES_PASSWORD=password -e POSTGRES_DB=documentdb -p 5432:5432 -d postgres
cd ${project.build.directory}/repackage
java -jar com.sensiblemetrics.api.ws-document-generator-0.1.0-SNAPSHOT-exec.jar
where
project.build.directory=modules/document-generator/.build/bin/com.sensiblemetrics.api.ws.document.generator
or simply run:
scripts/run.bat
kubectl run spring-boot-jib --image=$IMAGE --port=8080 --restart=Never
kubectl port-forward spring-boot-jib 8080
docker pull alexanderr/ws-documents:0.1.0-SNAPSHOT
Choose one of the modules and add to your pom.xml
<dependency>
<groupId>com.sensiblemetrics.api.ws</groupId>
<artifactId>{module.artifactId}</artifactId>
<version>{lib.version}</version>
</dependency>
Bundle with all WebDocs dependencies:
- WebDocs All
webdocs-all
- Library to work with WebDocs API.
WebDocs module dependencies:
-
WebDocs Actuator
webdocs-actuator
- Library to work with Actuator API. -
WebDocs Admin
webdocs-admin
- Library to work with Admin API. -
WebDocs Caching
webdocs-caching
- Library to work with Caching API. -
WebDocs Commons
webdocs-commons
- Library with utilities for common use cases. -
WebDocs Discovery
webdocs-discovery
- Library to work with Discovery API. -
WebDocs Document-Generator
webdocs-document-generator
- Library to work with Document-Generator API. -
WebDocs Eureka
webdocs-eureka
- Library to work with Eureka API. -
WebDocs Executor
webdocs-executor
- Library to work with Executor API. -
WebDocs Logger
webdocs-logger
- Library to work with Logger API. -
WebDocs Metrics
webdocs-metrics
- Library to work with Metrics API. -
WebDocs Router
webdocs-router
- Library to work with Router API. -
WebDocs Security
webdocs-security
- Library to work with Security API. -
WebDocs Validation
webdocs-validation
- Library to work with Validation API. -
WebDocs Tests
webdocs-tests
- Library with WebDocs tests.
You can find more useful libs and examples on wiki
WS-Documents is maintained by:
with community support please contact with us if you have some question or proposition.
SensibleMetrics Team would like inform that JetBrains is helping by provided IDE to develop the application. Thanks to its support program for an Open Source projects!
SensibleMetrics WS-Documents project is using SonarCloud for code quality. Thanks to SonarQube Team for free analysis solution for open source projects.
SensibleMetrics WS-Documents is distributed under LGPL version 3 or later, see COPYING.LESSER(LGPL) and COPYING(GPL).
LGPLv3 is additional permissions on top of GPLv3.