Skip to content

README.md

Latest commit

 

History

History
47 lines (36 loc) · 1.83 KB

README.md

File metadata and controls

47 lines (36 loc) · 1.83 KB
Raw

Jet

A backend service for Flare and flare-viewer.

Compiling for production

First, you need a spare database. This database will be cleared up, and used by Flyway to create the structure in which JOOQ will base of its auto-generated code.
As a recommendation, use a service database in GitHub actions to create a disposable database.

Add your credentials to gradle.properties:

# Database credentials for code generation
jet.jooq.database.url = jdbc:postgresql://localhost:5432/flare?ssl=require
jet.jooq.database.user = pgactions
jet.jooq.database.password = pgactions

Then, compile the project by running the following command

  gradlew build

Finally, find the jar in /build/libs/ and run it using:

  java -jar Jet.jar

Supported Frontends

Jet was designed to work on pair with flare-viewer.
Since the Flare protocol expects a single endpoint for both submitting data and using the web-ui, it is highly recommended to use a reverse proxy like Nginx or Caddy to forward the requests accordingly.

Client

Jet is compatible with any platform that provides Flare

  1. As a standalone plugin
    1.1. FlarePlugin
    1.2. FlarePlatform (recommended)
  2. Provided by a server software
    2.1. Pufferfish and forks
    2.2. Puffernot/Pufferfork and forks (recommended)

License

Jet is free and open source software, released under the AGPL license.
Refer to LICENSE for details.