Note
You can see a use case of the template with RESTest at BOTICA-RESTest.
-
Use this repository as a template for your project.
-
Install BOTICA as a local dependency, following the steps described at BOTICA README.
-
Configure your project.
- Define your bot properties file according to your needs. You can find more information in the BOTICA Wiki.
- Create all the necessary Launcher classes based on the types of bots you have defined. You can find more information in the BOTICA Wiki.
- Create the necessary property files to define how configuration file generation and launching of the Collector bot will be carried out. You can find more information in the BOTICA Wiki.
-
Compiling the project.
Open a terminal at the project's root and run the following Maven command to compile and package the project.
mvn clean install -
Generate the necessary files to launch the BOTICA environment.
- To use the default file located in
src/main/resources/BOTICAConfig/configuration-setup.properties, run the following maven command at the root of the project:mvn exec:java@configuration-setup - To use a file located in another path, run the following maven command at the root of the project:
mvn exec:java@configuration-setup -Dexec.args="path/to/file"
- To use the default file located in
-
Launch the BOTICA environment.
In case you are using Windows operating system, you can run the generated .bat file in the root of your project with the name
launch_botica.bat.Alternatively, you can use a defined command that performs the same execution process:
mvn exec:exec@launch-botica-windowsIf, on the other hand, you are using a Unix-based system, you can run the generated .sh file in the root of your project with the name
launch_botica.sh.Alternatively, you can use a defined command that performs the same execution process:
mvn exec:exec@launch-botica-unix -
Shut down the BOTICA environment.
To shut down the running BOTICA environment, run the following maven command at the root of the project:
mvn exec:java@launch-shutdown