ArhiXML is used to create and maintain the digital archive used by ARHiNET information system. A digital archive itself is a file which uses an XML format powered by the XML schema. It is a web application written in Java using Vaadin web framework.
The goal of this project was to try-out and learn Vaadin. The source code is not something that I am proud of nor it does contain any good design. UI is particularly not done well and has some non-critical bugs. But apparently, ArhiXML it is used in production. Maybe one day, I will rewrite it into something more better.
I strongly advise you to follow the How To Run ArhiXML From Docker Image if you want to use ArhiXML on your own computer.
The How To Build And Run ArhiXML From Source is used only if you are an ArhiXML developer and want to extend its code.
This is the easiest approach to running the ArhiXML. To do so, you will need Docker.
Docker installation depends on the operating system. Microsoft Windows, GNU/Linux, and macOS are all supported. There is a nice step-by-step documentation that you can follow to install Docker for your operating system.
Now that the Docker is installed, you need to download the prebuild image by executing following command in your terminal:
docker pull hvarga/arhixmlFinally, to run the ArhiXML, execute the following command also from your terminal:
docker run -p 8080:8080 --rm hvarga/arhixmlThat's it! Your ArhiXML instance is ready to use. Just open up your web browser and type http://localhost:8080/ into your address bar.
The first thing is to get the project source files. This involves cloning of the Git repository. Git needs to be installed in order to clone this repository. If not already installed go here, download and install.
After project source files are in possession, the project needs to be built. To actually build the project from the source files one must have Apache Ant tool installed onto his machine. If you don't have the tool installed download it from here and install. The second prerequisite is to have a Java Development Kit installed. If you don't have one, download it from here and install. Minimum Java SE 7 is required.
The final step is to actually start the build process using the Apache Ant. Just run the Apache Ant in the root directory of the project source files and the tool will take care of the building process.
ant
For the above to work, Apache Ant executable must be in a $PATH.
After Apache Ant successfully completes the building process ArhiXML application is ready for use. You can now start the application with:
java -jar dist/ArhiXML.war
This will start the embedded servlet container which will in turn host the ArhiXML application. You can also install the application on a dedicated servlet container like Apache Tomcat, which is preferred.