diff --git a/README.md b/README.md new file mode 100644 index 0000000000000000000000000000000000000000..e9ad003e3435c5c8d0a1c03040947710702f59f7 --- /dev/null +++ b/README.md @@ -0,0 +1,35 @@ +#### JAMS (Jami Account Management Server) + +##### Requirements + +* JDK 11+ +* maven + +##### Building from source + +Clone the contents of this repository and run + +``` +mvn clean packge +``` + +This will create a distribution folder called ``jams`` in the root folder. You can +then launch the server by running + +```java -jar jams-launcher``` + +If you want to start the server with an SSL certificate and on a port different +from 8080, then run: + +```java -jar jams-launcher 8443 server.pem server.key``` + +Where the ``pem`` and ``key`` files are a pem encoded certificate and key. + +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, change enter the ``jams-server`` directory and simply run: + +```apidoc -i src/ -o doc/``` \ No newline at end of file