studio/element-call
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update Development Section

Browse Source
This commit is contained in:
fkwp
2025-03-05 21:17:54 +01:00
parent 1df5872215
commit 5583f621ba
1 changed files with 22 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files

39
README.md
View File

@@ -143,7 +143,8 @@ If you'd like to help translate Element Call, head over to
the [Element Translators](https://matrix.to/#/#translators:element.io) space to the [Element Translators](https://matrix.to/#/#translators:element.io) space to
discuss and coordinate translation efforts. discuss and coordinate translation efforts.
## Development
## 🛠️ Development
### Frontend ### Frontend
@@ -155,13 +156,15 @@ cd element-call
yarn yarn
``` ```
To use it, create a local config by, e.g., `cp ./config/config.devenv.json ./public/config.json` To use it, create a local config by, e.g.,
and adapt it if necessary. The `config.devenv.json` config should work with the backend `cp ./config/config.devenv.json ./public/config.json` and adapt it if necessary.
development environment as outlined in the next section out of box. The `config.devenv.json` config should work with the backend development
environment as outlined in the next section out of box.
(Be aware, that this `config.devenv.json` is exposing a deprecated fallback > [!NOTE]
> Be aware, that this `config.devenv.json` is exposing a deprecated fallback
LiveKit config key. If the homeserver advertises SFU backend via LiveKit config key. If the homeserver advertises SFU backend via
`.well-known/matrix/client` this has precedence.) `.well-known/matrix/client` this has precedence.
You're now ready to launch the development server: You're now ready to launch the development server:
@@ -196,11 +199,13 @@ yarn backend
<img src="https://codecov.io/github/element-hq/element-call/graphs/tree.svg?token=O6CFVKK6I1"></img> <img src="https://codecov.io/github/element-hq/element-call/graphs/tree.svg?token=O6CFVKK6I1"></img>
### Add a new translation key ### Add a new translation key
To add a new translation key you can do these steps: To add a new translation key you can do these steps:
1. Add the new key entry to the code where the new key is used: `t("some_new_key")` 1. Add the new key entry to the code where the new key is used:
`t("some_new_key")`
1. Run `yarn i18n` to extract the new key and update the translation files. This 1. Run `yarn i18n` to extract the new key and update the translation files. This
will add a skeleton entry to the `locales/en/app.json` file: will add a skeleton entry to the `locales/en/app.json` file:
@@ -212,18 +217,18 @@ To add a new translation key you can do these steps:
} }
``` ```
1. Update the skeleton entry in the `locales/en/app.json` file with 1. Update the skeleton entry in the `locales/en/app.json` file with the English
the English translation: translation:
```jsonc
{
...
"some_new_key": "Some new key",
...
}
```
```jsonc
{
...
"some_new_key": "Some new key",
...
}
```
## Documentation
Usage and other technical details about the project can be found here: Usage and other technical details about the project can be found here: