diff --git a/README.md b/README.md index 7824587fec54ceb5ca9780cbfeaaf6a2c14d07b9..f4f9b20cbd04555953d7b001d8ffb7a5b5f8e33a 100644 --- a/README.md +++ b/README.md @@ -1 +1,23 @@ -# jaas-server +# Jami-web + +Jami-web is a web server that starts a Dameon on NodeJS express server and serve a React web client. + +The first milestone is to allow user with LDAP credentials to connect to the account using JAMS service and start chatting with their contacts using instant messaging. + +Next step will be to implement a video protocol such as WebRTC to allow audio and video calls from the users browser to another Jami contact allowing cross-platform communications. + +# Main dependencies + +* Jami Daemon with NodeJS bindings (https://review.jami.net/admin/repos/jami-daemon), +* NodeJS v16+ ++ Swig 4.1.0 + +# How to start the server + +After building the Jami daemon you can use the following command to start the node js server using the LD_LIBRARY_PATH + +Where $PATH_TO_JAMI_PROJECT is the path to the shared library of your Jami daemon + +LD_LIBRARY_PATH=$PATH_TO_JAMI_PROJECT/ring-project/install/daemon/lib node + +To build the dring.node Javascript interface to talk to the daemon api go to the daemon repo and use ./configure --with-nodejs then execute make -j4 to build the daemon diff --git a/README.txt b/README.txt deleted file mode 100644 index 51388abb60aca45496ad53ddc7f3487560824de7..0000000000000000000000000000000000000000 --- a/README.txt +++ /dev/null @@ -1,22 +0,0 @@ -# Jami-web - -Jami-web is a web server that starts a Dameon on NodeJS express server and serve a React web client. - -The first milestone is to allow user with LDAP credentials to connect to the account using JAMS service and start chatting with their contacts using instant messaging. - -Next step will be to implement a video protocol such as WebRTC to allow audio and video calls from the users browser to another Jami contact allowing crossplateform communications. - -# Main dependencies - -* Jami Deamon with NodeJS bindings (https://review.jami.net/admin/repos/jami-daemon), -* NodeJS v16+ - -# How to start the server - -After building the Jami daemon you can use the following command to start the node js server using the LD_LIBRARY_PATH - -Where $PATH_TO_JAMI_PROJECT is the path to the shared library of your Jami daemon - -LD_LIBRARY_PATH=$PATH_TO_JAMI_PROJECT/ring-project/install/daemon/lib node - -To build the dring.node Javascript interface to talk to the daemon api go to the daemon repo and use ./configure --with-nodejs then execute make -j4 to build the daemon