To run AOAME locally you first need to install the following software:
Git: https://git-scm.com/downloads
JDK: https://adoptium.net/temurin/archive/?version=17 Make sure you install the current version of the project: Temurin 17.0.7+7
Either IntelliJ: https://www.jetbrains.com/idea/download/ (requires academic license)
or Eclipse: https://www.eclipse.org/downloads/ or only Maven: https://maven.apache.org/
Optionally WebStorm: https://www.jetbrains.com/webstorm/ (requires academic license)
Node.js: https://nodejs.org/en/blog/release/v16.4.2
Important: Install the node version that is required by the WebApp project in package.json. Check it via the link: WebApp repo package.json
If you want to make changes to the code of the WebService it is recommended to install IntelliJ or Eclipse which comes with its own version of Maven. If you do not plan on making changes to the WebService it is also possible to install Maven on its own.
When installing Eclipse make sure to choose “Eclipse IDE for Enterprise Java and Web Developers”.
WebStorm is not needed for running AOAME locally but it can be used to make changes on the WebApp.
Start by running the setup_local.bat script.
(link to script: https://github.com/BPaaSModelling/AOAME_Scripts)
This will use git to download the three repositories: fuseki-heroku-test, OntologyBasedModellingEnvironment-WebService and OntologyBasedModellingEnvironment-WebApp.
After the script has finished, you will need to build the WebService and the WebApp before they can be used.
Start IntelliJ, open the WebService project: click File, Open, provide the path to WebService. The WebService is inside of newly created aoame folder OntologyBasedModellingEnvironment-WebService.
To build the project, click Run and Edit Configurations. Then, add the following configuration in IntelliJ and run it.
Start Eclipse and click File then Import…
Select Projects from Folder or Archive. Then click on Next.
The setup_local.bat script should have created a folder called aoame which contains a folder called OntologyBasedModellingEnvironment-WebService. Select the OntologyBasedModellingEnvironment-WebService folder by clicking Directory… and navigating to it.
After you have selected the directory click Finish.
Now you need to setup a run configuration. To do that click on the down arrow then on Run As and the on Maven build.
In the Goals field write package. Then click on Run to start the Maven build.
The next time you want to build the WebService you can run Maven by clicking on OntologyBasedModellingEnvironment-WebService inside the dropdown menu.
If you use Maven directly you can build the WebService by running mvn verify.
Open Run configrations again, click on the + sign to add a new JAR Application.
Provide the Path to JAR according to your setup.
Enter Program arguments, as shown below.
Add Run Maven package to Before launch, right below. This will build the project before every launch.
Finally, press run or debug buttons.
First open the folder OntologyBasedModellingEnvironment-WebApp inside WebStorm. Then click on Add Configuration…
Click on the plus symbol at the top left of the dialog.
Select npm on the dropdown.
On the Scripts dropdown select build. You have now added a configuration to build the WebApp.
To start building the WebApp make sure that build is selected on the dropdown then click on the green arrow to the right of the dropdown.
You can also add a second configuration with heroku-start. This can be used to start the WebApp through WebStorm.
If you do not want to use WebStorm you can use the command ng build to build the WebApp.
To start fuseki, the WebService and the WebApp at the same time you can use the start_local.bat script.
To start fuseki on its own run the fuseki-server.bat script inside the fuseki-heroku-test folder.
To start the WebService on its own run the start webserver.bat script inside the OntologyBasedModellingEnvironment-WebService folder.
To start the WebApp on its own run node server.js in a command prompt inside the OntologyBasedModellingEnvironment-WebApp folder.
To push your version to GitHub follow the steps below:
1. Ensure you have access to the required repositories for your project. Depending on the scope, it might be 1-3 repos:
https://github.com/BPaaSModelling/OntologyBasedModellingEnvironment-WebApp
https://github.com/BPaaSModelling/OntologyBasedModellingEnvironment-WebService
To push a new ontology you will need access to:
https://github.com/BPaaSModelling/Ontology4ModelingEnvironment
2. Create a personal access token to push it from Intellij/WebStorm/Eclipse, unless you have another authentication method like the ssh key. Usually, the GitHub account password doesn’t work.
Open GitHub -> Settings -> Developer Settings ->Personal access tokens -> Tokens (classic) -> Create one token with default repo access -> copy the token, you will need it later.
3. Open Intellij/WebStorm/Eclipse. Go to Git -> Connect to the respective repository -> Use your token as a password when connecting.
4. Create a new branch for your version, commit all your changes, and push.
5. Now, merge your branch into the master branch.
In Intellij or WebStorm, right-click the master branch and click "checkout the master". Now, you can merge your branch into the master branch (screenshot below). Once it is done, please test that everything works as expected. If testing is successful, push the new master branch.
If you need to push to the Ontology4ModelingEnvironment repo, first you need to merge the master into your own branch.
Create a Pull request directly from GitHub that will be merged when approved (see screenshots).
