Thanks to visit codestin.com
Credit goes to github.com

Skip to content

jdrouet/Xeres

 
 

Xeres

This is an attempted reimplementation of Retroshare in Java.

Supported platforms

  • Windows (x86_64)
  • Linux (x86_64)
  • MacOS (x86_64) untested

Build requirements

  • Java 17

Features

Download

https://xeres.io

Donations

Method Address
GitHub https://github.com/sponsors/zapek
PayPal https://www.paypal.me/zapek666
BTC bc1qn57zvp8s3h6renf805fan53kt7q4j963g7prvt
XMR 84czz4Vg44GaGmQF8Lst3uWEMyXLSahBffhrDd77jdVJEoKCtUJF96mGQ4XzcYrLG1JGaj2hr2sMoDoihQ52MT1jMBnucyu
GOST GM72AdtcAKLT8DGHSgDGeTA8Zsub23wL4K
ETH 0x7d9EfEe706c81227c73DA7814319301C6Bd63D05
ZEN znePxvhiUQLp7arEEVvuC1rkofgJf3LZ2uw
DASH Xqa3APRoHKzrF1w8fWVHG3Ae5ZaaSZMgio
BAT https://github.com/zapek/Xeres/commits?author=zapek (use tip button in Brave browser)

How to run

IntelliJ IDEA Ultimate

It is recommended to run the XeresApplication Spring Boot configuration which is the most convenient and fastest way.
Just make sure to configure it in the following way:

Select Edit Configurations... of the XeresApplication Spring Boot configuration.

Put the following VM options:

-ea -Djava.net.preferIPv4Stack=true

And the following Active profiles:

dev

Optionally, for faster build/test turnarounds you can add in the program arguments:

--fast-shutdown

Then just run the XeresApplication Spring Boot configuration.

IntelliJ Community Edition

Run the Gradle bootRun target. It's in the top right Gradle panel, Tasks / application. It's already preconfigured.

(This way also works with IntelliJ IDEA Ultimate, but you'll miss some extras like colored debug output and faster launch)

Command line
Windows
gradlew.bat bootRun
Linux
./gradlew bootRun

To pass Xeres arguments, just use the args feature, for example:

./gradlew bootRun --args="--no-gui --fast-shutdown"

(Use --help to know all arguments)

How to set up the WebUI

Note: the webui is currently nonfunctional.

Run the gradle tasks installAngular (if you don't already have Angular installed) then buildAngular. The later will create the needed files that will be served by Xeres on localhost:1066.

Database debugging

With IntelliJ Ultimate, create the following Database connection with the built-in Datagrip client (aka the Database tool window)

  • Connection type: Embedded
  • Driver: H2
  • Path: select ./data/userdata.mv.db. If the file is not there, run Xeres once.
  • Authentication: User & Password
  • User: sa
  • There's no password

Misc

The project was started on 2019-10-30.

Git branching model

The current plan is to use master for everything. Use a feature branch to work on a feature (for example, feature/165 if there's a ticket). Once it's ready, have someone review it then merge to master.

Releases will use tags and release branches if further fixes are needed.

https://reallifeprogramming.com/git-process-that-works-say-no-to-gitflow-50bf2038ccf7

Useful Gradle tasks

Cleaning the build directory

run the clean task

Cleaning the Angular generated directory

run the cleanAngular task

Upgrading Gradle
  • change the version in build.gradle in the wrapper section
  • run the wrapper task

About

The Ultimate Peer-to-Peer Solution

Resources

License

Code of conduct

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Java 98.0%
  • TypeScript 1.2%
  • Other 0.8%