Skip to content

Project structure

Jump to bottom
Otniel Nicola edited this page Jun 20, 2018 · 4 revisions

Project structure

The project has a basic java-project structure:

aion_ui
    \lib
    \mod
    \pack
    \scripts
    \src
        \main
            \java
                \org.aion.wallet
            \resources
                \native.linux
                \org.aion.wallet.ui
        \test
            \java
                \org.aion.wallet
            \resources
                \native.linux

lib

This folder contains jars of public libraries

mod

This folder contains jars of aion core modules that are used as libraries

pack

This is the output directory for the packed aion_ui.jar and aion_ui.tar.gz

scripts

This folder contains the script that launches the wallet application - aion_ui.sh

src

main/java

This folder contains the production sources that will be compiled

main/resources

This folder contains the resources needed by the production code to operate. These fall in 2 categories:

  • Native resources - these are platform-specific compiled libraries used for encryption, hashing and communication
  • UI resources - these are FXML files that describe the UI components, css files for styling and icons used in the project

test/java

This folder contains the test sources

test/resources

This folder contains the resources needed by the test code to operate. They are mostly native libraries that need to be loaded by the tests

Limitations

Due to the fact that the project needs some native libraries to function properly, and we only have said libraries for the Linux platform, the UI is currently usable only on Linux platforms.

Development process

For the development process the following git workflow was used:

This means that the dev branch holds the latest features that are made for the next release and these features will be merged into master only when a release is made.

Clone this wiki locally