https://github.com/qubitpi/bertok
A REST API Webservice serving QubitPi/wilhelm
https://github.com/qubitpi/bertok
java-17 jersey-framework jersey-jetty-rest jetty rest-api swagger webservice
Last synced: 18 days ago
JSON representation
A REST API Webservice serving QubitPi/wilhelm
- Host: GitHub
- URL: https://github.com/qubitpi/bertok
- Owner: QubitPi
- License: apache-2.0
- Created: 2024-08-29T07:57:38.000Z (8 months ago)
- Default Branch: master
- Last Pushed: 2025-01-17T07:35:11.000Z (3 months ago)
- Last Synced: 2025-01-17T08:22:03.221Z (3 months ago)
- Topics: java-17, jersey-framework, jersey-jetty-rest, jetty, rest-api, swagger, webservice
- Language: Java
- Homepage: https://bertok.wilhelmlang.com/
- Size: 9.83 MB
- Stars: 0
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Wilhelm Webservice
==================
![Java Version Badge][Java Version Badge]
[![Apache License Badge]][Apache License, Version 2.0]
__wilhelm-ws__ is a [JSR 370] [JAX-RS] webservice exclusively serving [wilhelmlang.com](https://wilhelmlang.com/)
Development
-----------
### Getting Source Code
```console
[email protected]:QubitPi/wilhelm-ws.git
cd wilhelm-ws
```
#### Running Tests
```console
mvn clean verify
```
### Generating WAR file
wilhelm-ws favors running in an external Jetty container, so its executable is not a fat JAR but a WAR which can be
compiled up with
```console
mvn clean package
```
### Starting Webservice Locally
Navigate to a dedicated directory; make sure port 8080 is not occupied and the following environment variables are set:
```console
export NEO4J_URI=
export NEO4J_USERNAME=
export NEO4J_PASSWORD=
export NEO4J_DATABASE=
```
Then start webservice with:
```bash
./jetty-start.sh
```
Press `Ctr-C` to stop the webservice and delete generated directories if needed when done.
### Deployment
wilhelm-ws has a dedicated release definition called
[wilhelm-ws-release-definition](https://github.com/QubitPi/wilhelm-ws-release-definition) for its automated deployment.
Please check that our for details.
License
-------
The use and distribution terms for [wilhelm-ws]() are covered by the [Apache License, Version 2.0].
[Apache License Badge]: https://img.shields.io/badge/Apache%202.0-F25910.svg?style=for-the-badge&logo=Apache&logoColor=white
[Apache License, Version 2.0]: https://www.apache.org/licenses/LICENSE-2.0
[Java Version Badge]: https://img.shields.io/badge/Java-17-brightgreen?style=for-the-badge&logo=OpenJDK&logoColor=white
[JAX-RS]: https://jcp.org/en/jsr/detail?id=370
[JSR 370]: https://jcp.org/en/jsr/detail?id=370