mirror of https://github.com/vector-im/element-call.git synced 2024-11-15 00:04:59 +08:00

Go to file

Avery 43e80dd9e7 Added translation using Weblate (Spanish)		2022-11-02 15:45:14 +00:00
.github	Attempt to fix triage automation	2022-11-01 22:31:56 -04:00
.storybook	Remove dependency on matrix-react-sdk	2022-04-07 14:22:36 -07:00
.vscode	Be more explicit in `.vscode/settings.json`	2022-07-16 08:28:08 +02:00
config	move config files into config/	2022-05-11 12:11:49 +01:00
public	Added translation using Weblate (Spanish)	2022-11-02 15:45:14 +00:00
scripts	move config files into config/	2022-05-11 12:11:49 +01:00
src	Don't doubly initialize the client in strict mode	2022-11-02 11:23:05 -04:00
test	Ensure that Olm is only loaded once	2022-10-31 13:43:03 -04:00
.dockerignore	Add CI	2021-12-20 16:59:39 +00:00
.env.example	Change default	2022-10-26 16:33:22 +02:00
.eslintrc.cjs	Fix lint	2022-10-27 09:54:31 -04:00
.gitignore	Add `.env` to `.gitignore`	2022-07-15 11:29:25 +02:00
.postcssrc.json	Add automatic css prefixing	2021-10-14 17:41:59 -07:00
.prettierignore	Add prettier support	2022-05-03 14:24:04 +01:00
.prettierrc.json	Add prettier support	2022-05-03 14:24:04 +01:00
babel.config.cjs	Add jest	2022-10-26 13:21:06 +02:00
CONTRIBUTING.md	CONTRIBUTING.md	2022-01-26 17:55:52 +00:00
Dockerfile	Add arm64 Docker image	2022-05-31 10:14:42 -07:00
i18next-parser.config.js	Set up translation with i18next	2022-10-12 14:53:49 -04:00
LICENSE	Add LICENSE	2021-07-16 14:31:42 -07:00
package.json	Update matrix-js-sdk	2022-11-01 19:56:30 -04:00
README.md	Improve the README	2022-11-01 22:21:09 -04:00
tsconfig.json	Add jest	2022-10-26 13:21:06 +02:00
vite.config.js	Clean up remaining 'Matrix Video Chat' branding	2022-11-01 22:19:44 -04:00
yarn.lock	Update matrix-js-sdk	2022-11-01 19:56:30 -04:00

README.md

Element Call

Full mesh group calls powered by Matrix, implementing MatrixRTC.

To try it out, visit our hosted version at call.element.io. You can also find the latest development version continuously deployed to element-call.netlify.app.

Host it yourself

Until prebuilt tarballs are available, you'll need to build Element Call from source. First, clone and install the package:

git clone https://github.com/vector-im/element-call.git
cd element-call
yarn
cp .env.example .env

You can now edit the configuration in .env to your liking. The most important thing is to set VITE_DEFAULT_HOMESERVER to the homeserver that the app should use, such as https://call.ems.host.

Next, build the project:

yarn build

If all went well, you can now find the build output under dist as a series of static files. These can be hosted using any web server of your choice.

Because Element Call uses client-side routing, your server must be able to route any requests to non-existing paths back to /index.html. For example, in Nginx you can achieve this with the try_files directive:

server {
    ...
    location / {
        ...
        try_files $uri /$uri /index.html;
    }
}

Development

Element Call is built against the robertlong/group-call branch of matrix-js-sdk. To get started, clone, install, and link the package:

git clone https://github.com/matrix-org/matrix-js-sdk.git
cd matrix-js-sdk
git switch robertlong/group-call
yarn
yarn link

Next, we can set up this project:

git clone https://github.com/vector-im/element-call.git
cd element-call
yarn
yarn link matrix-js-sdk
cp .env.example .env

By default, the app expects you to have Synapse installed locally and running on port 8008. If you wish to use another homeserver, you can set it in your .env file.

You're now ready to launch the development server:

yarn dev

Config

Configuration options are documented in the .env file.

Translation

If you'd like to help translate Element Call, head over to translate.element.io. You're also encouraged to join the Element Translators space to discuss and coordinate translation efforts.