Clone the contents of this repository and run
mvn clean package
This will create a distribution folder called jams in the root folder. You can then launch the server by running
cd jams java -jar jams-launcher.jar
If you want to start the server with an SSL certificate and on a port different from 8080, then run:
java -jar jams-launcher.jar 8443 server.pem server.key
Where the pem and key files are a pem encoded certificate and key.
In order to test JAMS with the Jami client, you need to generate a locally-trusted development certificate. Here is how to do it using mkcert:
First follow the mkcert installation guide.
Then run the following commands:
mkcert -install # Creates a local certificate authority (CA). This step is required only once. mkcert -key-file server.key -cert-file server.pem localhost 127.0.0.1 ::1 cp server.key server.pem /path/to/jami-jams/jams/
java -agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=localhost:35000 -jar jams-server.jar 8080
The code was formatted using google-java-format
that can be installed with npm:
npm install --global google-java-format
And is used with the following command:
google-java-format -i -a --skip-reflowing-long-strings **/*.java
To generate the documentation you will need apidoc installed on your system. This can be completed by running npm install -g apidoc, if for some reason that does not work, you can clone their project from : https://github.com/apidoc/apidoc and install it from source.
To build the documentation, enter the jams-server directory and simply run:
apidoc -i src/ -o doc/
You can then open doc/index.html. Click on 1.0.0 in the top right corner if the doc doesn't appear.
The extras folder contains a pre-commit hook that formats every js and java file. To enable it, run:
cp extras/scripts/pre-commit .git/hooks chmod +x .git/hooks/pre-commit
A development environment with react hot reloading can be created using:
docker build -f Dockerfile -t jams:dev --target dev . docker run -it -p 3000:3000 -p 8080:8080 -p 35000:35000 \ -v $(pwd)/jams-react-client/src:/app/jams-react-client/src \ -v $(pwd)/jams-react-client/public:/app/jams-react-client/public \ --rm jams:dev
setup_jams.sh can be used to quickly do the initial setup. The script creates user alice, bob, charlie and danny, all with the password "a", and they all belong to the group "defaultGroup".
./extras/scripts/setup_jams.sh
Note: It is possible that after 15 minutes, the user's token expires, the server will answer with a "You are not authentified" and forget to put the CORS headers, thus the browser will refuse to read the response. In this case, you will need to restart the server.
The following commands will generate the userguide and the jars needed:
docker build -f Dockerfile -t jams:latest --target prod . \ && CONTAINER=$(docker create jams:latest) \ && docker cp $CONTAINER:/app/jams/. jams \ && docker cp $CONTAINER:/app/versions.json . \ && docker rm -v $CONTAINER \ && cd jams \ && java -jar jams-launcher.jar
mvn clean test # to open the report files in the browser for f in */target/site/jacoco/index.html ; do xdg-open $f ; done # (optional) if the file doesn't open in your browser TYPE=$(xdg-mime query filetype datastore/target/site/jacoco/index.html) xdg-mime default firefox.desktop "$TYPE"
The DBeaver Community software can help visualize the database schema. You can install it from its official website. Once installed, here are the steps to access the database:
You can also use Apache Derby's official ij cli tool to access the database.
The files in the filters folder are prefixed "A", "B", "C" and "D" so that the order of execution of the filters are right (jakarta registers filters in alphabetical order).