/tr-pc

ThinkingRock for Personal Computers. Built on the Netbeans Platform.

Primary LanguageJavaGNU General Public License v3.0GPL-3.0

License Build

ThinkingRock for Personal Computer (i.e. any Desktop or Laptop computer)

License

GNU General Public License v3.0 or later

See LICENSE to see the full text.

How to build a project

Following is the proven way how to build and run the application from source code. Please beware, we do not have any prior experiences with Ant and NetBeans. There may be better ways to launch ThinkingRock. Any help and experience are highly welcomed.

Warning

Before starting ThinkingRock from sources, ensure you have a backup of your production data. We haven't yet figured out the configuration to cleanly separate the dev environment from the production configuration or data. This includes ReviewActions.xml as well. This issue will be solved in #33.

Compilation from a Terminal (without Netbeans)

Preconditions

  • Java is installed (Java 17)
  • Apache Ant is installed
  • Optional: just is installed

Run TR directly from sources

  • with 'just' installed, simply run just run (after having run just build at least once before)

Build artefacts and run

  • open a terminal window (Xterm, Konsole, Dos prompt, PowerShell...) and navigate to the root of the git clone tr-pc
  • run ant build-zip -Dnbplatform.default.netbeans.dest.dir=${path_to_repo}/netbeans-plat/22/ide (replace ${path_to_repo} with the absolte path to the checked out tr-pc repository)
  • you will find a zip file trgtd.zip inside the folder dist. Unzip it, navigate inside into the bin and start the respective binary for your OS.
  • with just installed, you can simply run just build-zip

Run From NetBeans

Precondition

  • Netbeans is installed
  • You have opened the tr-pc project in Netbeans

Run

  • Open Netbeans and open the project
  • Menu File -> Open Project. Navigate to the local git clone of tr-pc.
    Project
  • Open the node Module, choose one of the TR-Modules (e.g. TR Calendar), right-click and select Open Project
  • Right-click the now open module, and select Run
    Project run

Note: To our current knowledge, running Ant target run on the main project "Thinking Rock" will not launch the tool. Hence the workaround with running it from e.g. the "TR Calendar" project.

Note: With Netbeans installed and the project opened once, you don't need to specify the parameter nbplatform.default.netbeans.dest.dir when running ant anymore.