{"id":19177919,"url":"https://github.com/eyevinn/intercom-frontend","last_synced_at":"2025-05-07T20:42:43.705Z","repository":{"id":242742816,"uuid":"773738235","full_name":"Eyevinn/intercom-frontend","owner":"Eyevinn","description":"Low latency, web based, open source, high quality, voice-over-ip intercom solution","archived":false,"fork":false,"pushed_at":"2025-04-29T09:13:18.000Z","size":1328,"stargazers_count":5,"open_issues_count":21,"forks_count":5,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-05-07T20:42:36.958Z","etag":null,"topics":["intercom","voice","voip"],"latest_commit_sha":null,"homepage":"https://www.osaas.io/use-cases/intercom","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Eyevinn.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2024-03-18T10:05:21.000Z","updated_at":"2025-05-01T11:04:52.000Z","dependencies_parsed_at":"2024-06-04T19:54:35.137Z","dependency_job_id":"59c2ae34-394d-435d-93c2-44301e814e17","html_url":"https://github.com/Eyevinn/intercom-frontend","commit_stats":null,"previous_names":["eyevinn/intercom-frontend"],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Eyevinn%2Fintercom-frontend","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Eyevinn%2Fintercom-frontend/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Eyevinn%2Fintercom-frontend/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Eyevinn%2Fintercom-frontend/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Eyevinn","download_url":"https://codeload.github.com/Eyevinn/intercom-frontend/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252954127,"owners_count":21830893,"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","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":["intercom","voice","voip"],"created_at":"2024-11-09T10:35:48.203Z","updated_at":"2025-05-07T20:42:43.691Z","avatar_url":"https://github.com/Eyevinn.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Eyevinn Open Intercom Client\n\n[![Slack](https://slack.osaas.io/badge.svg)](https://slack.osaas.io)\n[![Badge OSC](https://img.shields.io/badge/Evaluate-24243B?style=for-the-badge\u0026logo=data:image/svg+xml;base64,PHN2ZyB3aWR0aD0iMjQiIGhlaWdodD0iMjQiIHZpZXdCb3g9IjAgMCAyNCAyNCIgZmlsbD0ibm9uZSIgeG1sbnM9Imh0dHA6Ly93d3cudzMub3JnLzIwMDAvc3ZnIj4KPGNpcmNsZSBjeD0iMTIiIGN5PSIxMiIgcj0iMTIiIGZpbGw9InVybCgjcGFpbnQwX2xpbmVhcl8yODIxXzMxNjcyKSIvPgo8Y2lyY2xlIGN4PSIxMiIgY3k9IjEyIiByPSI3IiBzdHJva2U9ImJsYWNrIiBzdHJva2Utd2lkdGg9IjIiLz4KPGRlZnM%2BCjxsaW5lYXJHcmFkaWVudCBpZD0icGFpbnQwX2xpbmVhcl8yODIxXzMxNjcyIiB4MT0iMTIiIHkxPSIwIiB4Mj0iMTIiIHkyPSIyNCIgZ3JhZGllbnRVbml0cz0idXNlclNwYWNlT25Vc2UiPgo8c3RvcCBzdG9wLWNvbG9yPSIjQzE4M0ZGIi8%2BCjxzdG9wIG9mZnNldD0iMSIgc3RvcC1jb2xvcj0iIzREQzlGRiIvPgo8L2xpbmVhckdyYWRpZW50Pgo8L2RlZnM%2BCjwvc3ZnPgo%3D)](https://app.osaas.io/browse/eyevinn-intercom-manager)\n\nEyevinn Open Intercom is a low latency, web based, open source, high quality, voice-over-ip intercom solution.\nIt is designed to be used in broadcast and media production environments, where low latency and high quality audio are critical.\nThe solution is built on top of WebRTC technology and provides a user-friendly interface for managing intercom channels and users.\n\n## Requirements\n\n- [Open Intercom Manager](https://github.com/Eyevinn/intercom-manager/) running and reachable\n\n## Hosted Solution\n\nAvailable as an open web service in [Eyevinn Open Source Cloud](https://www.osaas.io). Read this [documentation to quickly get started](https://docs.osaas.io/osaas.wiki/Service%3A-Intercom.html) with the hosted solution.\n\n## Get Started\n\nPre-requisites: [Node v20](https://nodejs.org/), [Yarn Classic](https://classic.yarnpkg.com/)\n\n`yarn` to install packages\n\n`cp .env.local.sample .env.local` to set up the local environment (do not skip!)\n\nTo use a local [Open Intercom Server](https://github.com/Eyevinn/intercom-manager/), set the environment variable `VITE_BACKEND_URL=http://0.0.0.0:8000/`\n\nDecide whether or not debug mode should be on or not `VITE_DEBUG_MODE=true`\n\nChoose desired level of logging `VITE_DEV_LOGGER_LEVEL=3`\n\n```\nLOGGER LEVELS\n0 = no logs\n1 = basic logs\n2 = colored logs\n3 = data logs\n```\n\n`yarn dev` to start a dev server\n\n### Open Intercom Server in Open Source Cloud\n\nTo develop using a server hosted by [Open Source Cloud](https://www.osaas.io/), you need to provide a bearer token (service access token) in the Authorization header. The environment should be set to:\n\n```\nexport VITE_BACKEND_URL=https://\u003cinstance\u003e.eyevinn-intercom-manager.auto.prod.osaas.io/\nexport OSC_ACCESS_TOKEN=\u003cpersonal-access-token\u003e\n```\n\nThe `\u003cpersonal-access-token\u003e` is found in the settings menu in the [user interface](https://app.osaas.io). To get the service access token you run the following command in your terminal.\n\n```bash\n% npx -y @osaas/cli service-access-token eyevinn-intercom-manager\n\u003cservice-access-token\u003e\n```\n\nThen you start the dev server with the `VITE_BACKEND_API_KEY` environment variable set. Either on the comand line or stored in the shell with `export VITE_BACKEND_API_KEY=\u003cservice-access-token\u003e`. The token expires after a while so you might need to refresh the token using the same command above.\n\n```bash\n% VITE_BACKEND_API_KEY=\u003cservice-access-token\u003e yarn dev\n```\n\nAs the Open Source Cloud platform apply same-origin principle you need to disable that check in your browser when developing locally. Example below on how to start Chrome on MacOS with this check disabled.\n\n```bash\n% open -a Google\\ Chrome --args --disable-web-security --user-data-dir=\"/tmp\"\n```\n\n## Docker Container\n\nBuild local Docker image\n\n```\ndocker build -t intercom-frontend:dev\n```\n\nRun container on port 8000 and with intercom manager on `https://\u003cintercom-manager-url\u003e/`\n\n```\ndocker run --rm -d -p 8000:8000 \\\n  -e PORT=8000 \\\n  -e MANAGER_URL=https://\u003cintercom-manager-url\u003e/ \\\n  --name=frontend \\\n  intercom-frontend:dev\n```\n\nThen the app is available at http://localhost:8000/\n\nStop container\n\n```\ndocker stop frontend\n```\n\n## Contributing\n\nContributions are welcome.\n\n### Git Ways of Working\n\nThe project uses feature branches, and a [rebase merge strategy](https://www.atlassian.com/git/tutorials/merging-vs-rebasing).\n\nMake sure you have `git pull` set to rebase mode:\n\n`git config pull.rebase true`\n\nOptionally, you can add the `--global` flag to the above command.\n\nTo start working on a new feature: `git checkout -b \u003cfeature branch name\u003e`.\n\nThis project uses [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/#summary).\n\nRead [Using Git with Discipline](https://drewdevault.com/2019/02/25/Using-git-with-discipline.html).\n\nRead [How to Write a Commit Message](https://chris.beams.io/posts/git-commit/).\n\nA commit should:\n\n- contain a single change set (smaller commits are better)\n- pass tests, linting, and typescript checks\n- not be broken\n\nAlong with enabling time saving automation, it enables extremely powerful debug workflows via [git bisect](https://git-scm.com/docs/git-bisect), making bug hunting a matter of minutes. There are a number of articles out there on the magic of bisecting.\n\nBasic structure of a commit message:\n\n```\n\u003ctype\u003e[optional scope]: \u003ctitle starting with verb in infinitive\u003e\n\n[optional body]\n\n[optional footer]\n```\n\nTry to describe what was added or changed, instead of describing what the code does. Example:\n\n`fix(seek): rewrite calculation in seek module` `// bad, the consumer does not know what issue this fixes`\n\n`fix(seek): stop player from freezing after seek` `// good, the consumer understands what is now working again`\n\n## Support\n\nJoin our [community on Slack](https://slack.osaas.io/) where you can post any questions regarding any of our open source projects. Eyevinn's consulting business can also offer you:\n\n- Further development of this component\n- Customization and integration of this component into your platform\n- Support and maintenance agreement\n\nContact [sales@eyevinn.se](mailto:sales@eyevinn.se) if you are interested.\n\n## About Eyevinn Technology\n\n[Eyevinn Technology](https://www.eyevinntechnology.se) help companies in the TV, media, and entertainment sectors optimize costs and boost profitability through enhanced media solutions.\nWe are independent in a way that we are not commercially tied to any platform or technology vendor. As our way to innovate and push the industry forward, we develop proof-of-concepts and tools. We share things we have learn and code as open-source.\n\nWith Eyevinn Open Source Cloud we enable to build solutions and applications based on Open Web Services and avoid being locked in with a single web service vendor. Our open-source solutions offer full flexibility with a revenue share model that supports the creators.\n\nRead our blogs and articles here:\n\n- [Developer blogs](https://dev.to/video)\n- [Medium](https://eyevinntechnology.medium.com)\n- [OSC](https://www.osaas.io)\n- [LinkedIn](https://www.linkedin.com/company/eyevinn/)\n\nWant to know more about Eyevinn, contact us at info@eyevinn.se!\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Feyevinn%2Fintercom-frontend","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Feyevinn%2Fintercom-frontend","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Feyevinn%2Fintercom-frontend/lists"}