{"id":24836735,"url":"https://github.com/tran-simon/jami-web","last_synced_at":"2025-10-14T10:31:08.481Z","repository":{"id":59178131,"uuid":"535417764","full_name":"tran-simon/jami-web","owner":"tran-simon","description":"Distributed video conference web app in React using WebRTC, Typescript, Express, OpenDHT. Fork of jami-web: https://review.jami.net/jami-web","archived":false,"fork":false,"pushed_at":"2022-12-07T01:19:37.000Z","size":4091,"stargazers_count":4,"open_issues_count":0,"forks_count":2,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-01-31T05:04:40.373Z","etag":null,"topics":["distributed","jami","react","typescript","webrtc"],"latest_commit_sha":null,"homepage":"https://jami.net/","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/tran-simon.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2022-09-11T20:27:57.000Z","updated_at":"2025-01-24T13:59:40.000Z","dependencies_parsed_at":"2023-01-24T12:45:32.268Z","dependency_job_id":null,"html_url":"https://github.com/tran-simon/jami-web","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/tran-simon/jami-web","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tran-simon%2Fjami-web","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tran-simon%2Fjami-web/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tran-simon%2Fjami-web/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tran-simon%2Fjami-web/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tran-simon","download_url":"https://codeload.github.com/tran-simon/jami-web/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tran-simon%2Fjami-web/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":279018781,"owners_count":26086452,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-10-14T02:00:06.444Z","response_time":60,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["distributed","jami","react","typescript","webrtc"],"created_at":"2025-01-31T05:04:38.762Z","updated_at":"2025-10-14T10:31:08.018Z","avatar_url":"https://github.com/tran-simon.png","language":"TypeScript","funding_links":[],"categories":["TypeScript"],"sub_categories":[],"readme":"# Jami Web\n\nThe web version of Jami.\n\nThe repo is structured as 4 subprojects:\n\n- `client`: the web front-end made with React\n- `server`: the back-end server made with Express.js, which starts a daemon instance\n- `common`: the common code used by both `client` and `server`\n- `daemon`: a submodule containing the Jami daemon\n\n## Prerequisites\n\n- Linux\n- [Node.js 16](https://nodejs.org/en/)\n- [npm](https://www.npmjs.com/)\n- [SWIG 4.1.0:](https://www.swig.org/)\n\n  - Build from source with the following instructions: \u003chttps://swig.org/svn.html\u003e\n\n    \u003e Note: you will need have Bison installed. On Ubuntu, this can be installed using `sudo apt install bison`.\n\n    ```sh\n    git clone https://github.com/swig/swig.git\n    cd swig\n    ./autogen.sh\n    ./configure\n    make\n    sudo make install\n    ```\n\n## Setup\n\n### Build the Jami daemon with Node.js bindings\n\n1. Install the required dependencies: \u003chttps://docs.jami.net/build/dependencies.html\u003e\n\n   \u003e Note: for Ubuntu, the minimally needed dependencies are:\n\n   ```\n   sudo apt install git build-essential cmake automake autoconf autopoint libtool pkg-config libdbus-1-dev libva-dev libvdpau-dev libasound2-dev libpulse-dev libudev-dev libexpat1-dev ssnasm yasm yasm nasm\n   ```\n\n2. Compile the dependencies:\n\n   ```sh\n   cd daemon/contrib\n   mkdir native\n   cd native\n   ../bootstrap\n   make -j$(nproc)\n   ```\n\n3. Install `node-gyp` to build the daemon with Node.js bindings:\n\n   ```\n   npm install -g node-gyp\n   ```\n\n4. Compile the daemon with Node.js bindings:\n\n   ```sh\n   cd ../..\n   ./autogen.sh\n   ./configure --with-nodejs\n   make -j$(nproc)\n   ```\n\n5. Create a symlink to `jamid.node` in `server`:\n\n   ```sh\n   cd ../server\n   ln -s ../daemon/bin/nodejs/build/Release/jamid.node jamid.node\n   cd ..\n   ```\n\n### Install npm dependencies and set up Git hooks\n\n```\nnpm install\n```\n\nThis will install the relevant dependencies for all subprojects and configure Git hooks.\n\n## Usage\n\n### Run with hot-reload for development\n\nStart both the client and server:\n\n```sh\nLD_LIBRARY_PATH=\"${PWD}/daemon/src/.libs\" npm start\n```\n\nYou can also start the client and server individually:\n\n```sh\nnpm start --workspace client\nLD_LIBRARY_PATH=\"${PWD}/daemon/src/.libs\" npm start --workspace server\n```\n\nOpen \u003chttp://localhost:3000\u003e in your browser to view the app.\n\n### Build for production\n\n```\nnpm run build\n```\n\n### Preview the production build\n\n```sh\nLD_LIBRARY_PATH=\"${PWD}/daemon/src/.libs\" npm run start:prod\n```\n\n### Lint files\n\n```\nnpm run lint\n```\n\nLint and fix files:\n\n```\nnpm run lint:fix\n```\n\n### Format files\n\n```\nnpm run format\n```\n\n### Clean build output\n\n```\nnpm run clean\n```\n\n## Using a Docker container for development\n\nYou may instead wish to use a Docker container for development.\n\nThis allows you to avoid having to install all the dependencies needed to build the daemon on your computer. The container is meant for development: it uses bind mounts to mount the source code from your computer into the container, so that the container rebuilds the project whenever changes are made locally.\n\n### With Docker Compose\n\n1. Build the Docker image for the daemon:\n\n   ```\n   docker-compose build jami-daemon\n   ```\n\n2. Build the Docker image for Jami web:\n\n   ```\n   docker-compose build\n   ```\n\n3. Run the Docker container:\n\n   ```\n   docker-compose up\n   ```\n\n### Without Docker Compose\n\n1. Build the Docker image for the daemon:\n\n   ```sh\n   cd daemon\n   docker build --build-arg config_args=\"--with-nodejs\" -t jami-daemon .\n   cd ..\n   ```\n\n2. Build the Docker image for Jami web:\n\n   ```sh\n   docker build --target development --t jami-web .\n   ```\n\n3. Run the Docker container:\n\n   ```\n   docker run -it \\\n       -p 3000:3000 \\\n       -p 5000:5000 \\\n       --volume ${PWD}/client/src:/web-client/client/src \\\n       --volume ${PWD}/server/src:/web-client/server/src \\\n       --volume ${PWD}/client/.env.development:/web-client/client/.env.development \\\n       --volume ${PWD}/server/.env:/web-client/server/.env \\\n       jami-web\n   ```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftran-simon%2Fjami-web","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftran-simon%2Fjami-web","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftran-simon%2Fjami-web/lists"}