https://github.com/alexrogalskiy/ws-documents
WebDocs
https://github.com/alexrogalskiy/ws-documents
webdocs ws-documents
Last synced: 4 months ago
JSON representation
WebDocs
- Host: GitHub
- URL: https://github.com/alexrogalskiy/ws-documents
- Owner: AlexRogalskiy
- License: gpl-3.0
- Created: 2020-06-18T10:52:10.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2025-01-21T23:12:25.000Z (4 months ago)
- Last Synced: 2025-01-22T00:20:25.131Z (4 months ago)
- Topics: webdocs, ws-documents
- Language: Java
- Homepage:
- Size: 1.71 MB
- Stars: 2
- Watchers: 4
- Forks: 0
- Open Issues: 227
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: COPYING
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Security: security.md
Awesome Lists containing this project
README
# Web-Documents
[](https://sonarcloud.io/dashboard?id=AlexRogalskiy_ws-documents)
[]()
## Summary
Web service intended to provide operations on documents \(create, edit, fetch document's data and generate file in docx format by template\)
## Description
Application can be used for creating and editing document's data with possibility to generate final DocX-document by template
## Compile
### For JDK 8
```text
mvnw clean install spring-boot:repackage -Pnon_module_java,test-jar,xsd -DskipTests
```
to build image to Docker daemon:
```text
mvnw clean install -Pnon_module_java,test-jar,xsd,jib -DskipTests
```
### For JDK 11
```text
mvnw clean install spring-boot:repackage -Pmodule_java,test-jar,xsd,jib -DskipTests
```
building image to Docker daemon:
```text
mvnw clean package -Pmodule_java,test-jar,xsd,jib -DskipTests
```
buidling and deploying docker image to DockerHub:
```text
mvnw -s settings.xml clean package -Pmodule_java,test-jar,xsd,jib -DskipTests -Denv.DOCKERHUB_USERNAME= -Denv.DOCKERHUB_PASSWORD=
```
run local build/deployment process:
```text
skaffold config set --global local-cluster true
skaffold dev --trigger notify
```
## Run with Skaffold
In order to run the `ws-documents` service using _skaffold_, you need to have the _DocumentDB_ up and running:
#### 1. Start the document DB \(postgres\):
```text
skaffold run -p documents-db-local
```
#### 2. Start the ws-documents service:
```text
skaffold run -p local
```
## Run with containerized PostgreSQL
Run PostgreSQL in docker-container via command:
```text
docker run --name db-postgres -e POSTGRES_USER=postgres -e POSTGRES_PASSWORD=password -e POSTGRES_DB=documentdb -p 5432:5432 -d postgres
```
```text
cd ${project.build.directory}/repackage
java -jar com.sensiblemetrics.api.ws-document-generator-0.1.0-SNAPSHOT-exec.jar
```
where
```text
project.build.directory=modules/document-generator/.build/bin/com.sensiblemetrics.api.ws.document.generator
```
or simply run:
```text
scripts/run.bat
```
## Deploy with Kubectl
#### 1. Start the document service:
```text
kubectl run spring-boot-jib --image=$IMAGE --port=8080 --restart=Never
```
#### 2. Wait until pod is up and running:
```text
kubectl port-forward spring-boot-jib 8080
```
## Download Docker image \(RegistryHub\)
```text
docker pull alexanderr/ws-documents:0.1.0-SNAPSHOT
```
## Usage
Choose one of the modules and add to your `pom.xml`
```xml
com.sensiblemetrics.api.ws
{module.artifactId}
{lib.version}
```
Bundle with all WebDocs dependencies:
- [**WebDocs All**](https://github.com/AlexRogalskiy/ws-documents/tree/master/modules/all)
`webdocs-all` - Library to work with WebDocs API.
WebDocs module dependencies:
- [**WebDocs Actuator**](https://github.com/AlexRogalskiy/ws-documents/tree/master/modules/actuator)
`webdocs-actuator` - Library to work with Actuator API.
- [**WebDocs Admin**](https://github.com/AlexRogalskiy/ws-documents/tree/master/modules/admin)
`webdocs-admin` - Library to work with Admin API.
- [**WebDocs Caching**](https://github.com/AlexRogalskiy/ws-documents/tree/master/modules/caching)
`webdocs-caching` - Library to work with Caching API.
- [**WebDocs Commons**](https://github.com/AlexRogalskiy/ws-documents/tree/master/modules/commons)
`webdocs-commons` - Library with utilities for common use cases.
- [**WebDocs Discovery**](https://github.com/AlexRogalskiy/ws-documents/tree/master/modules/discovery)
`webdocs-discovery` - Library to work with Discovery API.
- [**WebDocs Document-Generator**](https://github.com/AlexRogalskiy/ws-documents/tree/master/modules/document-generator)
`webdocs-document-generator` - Library to work with Document-Generator API.
- [**WebDocs Eureka**](https://github.com/AlexRogalskiy/ws-documents/tree/master/modules/eureka)
`webdocs-eureka` - Library to work with Eureka API.
- [**WebDocs Executor**](https://github.com/AlexRogalskiy/ws-documents/tree/master/modules/executor)
`webdocs-executor` - Library to work with Executor API.
- [**WebDocs Logger**](https://github.com/AlexRogalskiy/ws-documents/tree/master/modules/logger)
`webdocs-logger` - Library to work with Logger API.
- [**WebDocs Metrics**](https://github.com/AlexRogalskiy/ws-documents/tree/master/modules/metrics)
`webdocs-metrics` - Library to work with Metrics API.
- [**WebDocs Router**](https://github.com/AlexRogalskiy/ws-documents/tree/master/modules/router)
`webdocs-router` - Library to work with Router API.
- [**WebDocs Security**](https://github.com/AlexRogalskiy/ws-documents/tree/master/modules/security)
`webdocs-security` - Library to work with Security API.
- [**WebDocs Validation**](https://github.com/AlexRogalskiy/ws-documents/tree/master/modules/validation)
`webdocs-validation` - Library to work with Validation API.
- [**WebDocs Tests**](https://github.com/AlexRogalskiy/ws-documents/tree/master/modules/tests)
`webdocs-tests` - Library with WebDocs tests.
## Version Store
[./pom.xml](https://github.com/AlexRogalskiy/ws-documents/blob/master/pom.xml)
## Miscellaneous
You can find more useful libs and examples on [wiki](https://github.com/AlexRogalskiy/ws-documents/wiki)
## Authors
WS-Documents is maintained by:
* [Alexander Rogalskiy](https://github.com/AlexRogalskiy)
with community support please contact with us if you have some question or proposition.
## Team Tools
[](https://www.jetbrains.com/)
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!
[](https://sonarcloud.io/dashboard?id=org.schemaspy%3Aschemaspy)
SensibleMetrics WS-Documents project is using SonarCloud for code quality.
Thanks to SonarQube Team for free analysis solution for open source projects.
## License
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.
