: Last Updated: 05 April 2024

Contribute

Requirements

OpenJDK

You need OpenJDK ( minimum jdk 11 ) which can be obtained from here
if you use the .zip version of jdk then you will need to extract the archive on your computer (eg. C:\jdk) and add the path to java.exe (eg. C:\jdk\bin) to your environment var PATH.
It's easier to use the .msi installer.
To check if you have Java in your path, open a command prompt and type java -version :

openjdk version "11.0.2" 2019-01-15
OpenJDK Runtime Environment 18.9 (build 11.0.2+9)
OpenJDK 64-Bit Server VM 18.9 (build 11.0.2+9, mixed mode)

When updating versions of Microsoft's JDK it does not remove the older version. You will need to use the Add/remove programs function of windows to remove the pre-existing version.

Apache Ant

Apache Ant is used with the OpenJDK to build and package the portapp.
You need at least Apache Ant 1.10.5 that you can download on the Apache website.
Extract the archive on your computer (eg. C:\apache-ant) and add the path to ant.bat (eg. C:\apache-ant\bin) to your environment var PATH.
To check if you have Apache Ant in your path, open a command prompt and type ant -version :

Apache Ant(TM) version 1.10.5 compiled on July 10 2018

Configuration

Fork and clone the module of your choice.
Clone dev in the parent folder of the module.
Create a new pull request with your work.

For example :

cd C:\work\
git clone --recursive https://github.com/bearsampp/module-adminer.git
git clone --recursive https://github.com/bearsampp/dev.git
cd module-adminer\

Directory structure example :

[-] dev
 | [-] build
 |  |  | build-commons.xml 
[-] bearsampp-{bin|app|tool}-{name}
 |  | build.xml

If you are not familiar with creating a pull request, you can create a new module like this :

Increment the build.release in the build.properties file using a YYYY.mm.dd format. Such as 2022.07.24
If you want you can change the build.path (default C:\bearsampp-build).
Open a command prompt in your module folder and call the Ant target release : ant release.
Upload your release on a file hosting system like Sendspace.
Create an issue on Bearsampp repository to integrate your release.