beenull/xpipe-mirror
1
0
Fork 0
mirror of https://github.com/xpipe-io/xpipe.git synced 2024-11-21 15:10:23 +00:00
Code Issues Projects Releases Packages Wiki Activity
Your entire server infrastructure at your fingertips
42 commits 89 branches 127 tags 29 MiB
Java 95.3%
CSS 4.1%
Shell 0.3%
PowerShell 0.3%
Find a file
Christopher Schnick c7c86b1bf8 Add license
2022-03-10 20:16:46 +01:00
.github/workflows Attempt to fix build 2022-03-10 20:04:54 +01:00
api Prepare workflows 2022-03-10 19:38:57 +01:00
beacon Prepare workflows 2022-03-10 19:38:57 +01:00
core Prepare workflows 2022-03-10 19:38:57 +01:00
deps@cbac51bc63 Attempt to fix build 2022-03-10 20:04:54 +01:00
extension Prepare workflows 2022-03-10 19:38:57 +01:00
gradle/wrapper Fix standalone unit tests 2022-03-10 18:48:06 +01:00
samples Prepare workflows 2022-03-10 19:38:57 +01:00
.gitattributes Initial commit 2021-12-01 19:17:54 +01:00
.gitignore Rework beacon connections and flesh out API more 2022-03-05 20:46:33 +01:00
.gitmodules Initial commit 2021-12-01 19:17:54 +01:00
gradlew Initial commit 2021-12-01 19:17:54 +01:00
gradlew.bat Initial commit 2021-12-01 19:17:54 +01:00
LICENSE Add license 2022-03-10 20:16:46 +01:00
README.md Prepare workflows 2022-03-10 19:38:57 +01:00
settings.gradle Fix standalone unit tests 2022-03-10 18:48:06 +01:00
version Cleanup, some documentation, and refactoring 2022-03-08 23:30:13 +01:00

README.md

X-Pipe Java

This repository contains the following four modules:

  • Core - Shared core classes of the Java API and the X-Pipe daemon implementation
  • API - The API that can be used to interact with X-Pipe from any JVM-based languages
  • Beacon - The X-Pipe beacon component is responsible for handling all communications between the X-Pipe daemon and the client applications, for example the various programming language APIs and the CLI
  • Extension - An API to create all different kinds of extensions for the X-Pipe platform

Development

All X-Pipe components target JDK 17 and make full use of the Java Module System (JPMS). All components are modularized, including all their dependencies. In case a dependency is (sadly) not modularized yet, module information is manually added using moditect. These dependency generation rules are accumulated in the X-Pipe dependencies repository, which is shared between all components and integrated as a git submodule.

Some unit tests depend on a connection to an X-Pipe daemon to properly function. To launch the installed daemon, it is required that the XPIPE_HOME environment variable is set or the xpipe / xpipe.exe CLI executable is added to the PATH variable.