Andreas/LibreChat
1
0
Fork 0
mirror of https://github.com/danny-avila/LibreChat.git synced 2025-12-17 00:40:14 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions 6

docs: updates (#841)

Browse source
This commit is contained in:
Fuegovic 2023-08-26 19:36:25 -04:00 • committed by GitHub
parent 39c626aa8e
commit 29d3640546
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
9 changed files with 162 additions and 204 deletions
Download patch file Download diff file Expand all files Collapse all files

2
docs/install/container_install.md
View file

@ -31,7 +31,7 @@ podman build \
--file ./LibreChat/Dockerfile;
```
> Not the downside of running a base container that has a live root is that image revisions need to be done manually. The easiest way is to remove and recreate the image when the container is no longer. If that's not possible for you, manually updating the image to increment versions can be done manually. Simply amend $image with the version you're building.
> Note: the downside of running a base container that has a live root is that image revisions need to be done manually. The easiest way is to remove and recreate the image when the container is no longer. If that's not possible for you, manually updating the image to increment versions can be done manually. Simply amend $image with the version you're building.
> We'll document how to go about the update process more effectively further on. You wont need to remove your existing containers, or lose any data when updating.

36
docs/install/default_language.md Normal file
View file

@ -0,0 +1,36 @@
# Default Language 🌍
## How to change the default language
- Open this file `client\src\store\language.js`
- Modify the "default" in the lang variable with your ISO 3166 Alpha-2 code :
Example:
from **English** as default
```js
import { atom } from 'recoil';
const lang = atom({
key: 'lang',
default: 'en',
});
export default { lang };
```
to **Italian** as default
```js
import { atom } from 'recoil';
const lang = atom({
key: 'lang',
default: 'it',
});
export default { lang };
```
---
### **If you wish to contribute your own translation to LibreChat, please refer to this document for instructions: [Contribute a Translation](../contributions/translation_contribution.md)**

113
docs/install/languages.md
View file

@ -1,113 +0,0 @@
# Languages 🌍
## Default language
1. Open this file "client\src\store\language.js"
2. modify the "default" in the lang variable with your ISO 3166 Alpha-2 code :
for example from english as default
```
import { atom } from 'recoil';
const lang = atom({
key: 'lang',
default: 'en',
});
export default { lang };
```
to italian as dafult
```
import { atom } from 'recoil';
const lang = atom({
key: 'lang',
default: 'it',
});
export default { lang };
```
# How to add a translation to LibreChat
### Minimum Requirements:
1. Good knowledge of the language (some terms may undergo significant changes during translation)
2. An editor, which can be Notepad or (**recommended**: [VSCode](https://code.visualstudio.com/download))
### Language translation
1. Fork the LibreChat repository and download it using git clone https://github.com/danny-avila/LibreChat
2. Navigate to the "client\src\localization" folder and open the "Translation.tsx" file
3. At the beginning of the code, add your language below all the others in this format:
`import Language-name from './languages/** ';`
For example, let's take English as an example:
Note: Replace "LanguageName" with the name of your language (capitalized) and "**" with the ISO 3166 Alpha-2 code of your country (the initial of the nation).
If you don't know the ISO 3166 code for your language, check it [here](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes) and also use it with an initial capital)
4. Further down in the code, add the following
`if (langCode === '**') return Language-name;`
Replace "**" with the ISO 3166 Alpha-2 code of your language (in lowercase). Here's an example: `if (langCode === 'en') return English;`)
7. Go into the "languages" folder and create a file named as follows: **.tsx
For example: En.tsx
9. Copy all the content from En.tsx into your file and modify it as follows:
```
// your-language-name phrases
export default {
com_ui_examples: 'Examples',
// Add more translations here
```
Rename only the part after the colon ":" to the corresponding translation in your language. For example:
```
// my-language phrases
export default {
com_ui_examples: 'WORD_THAT_I_TRANSLATE_IN_TO_MY_LANGUAGE',
// Add more translations here
};
```
⚠️DO NOT CHANGE com_... ⚠️
10. To add your language to the menu, open the file "client\src\components\Nav\SettingsTabs\General.tsx" and add your language to the "LangSelector" variable in the following way:
```
export const LangSelector = ({
//other code
<option value="en">{localize(lang, 'com_nav_lang_english')}</option>
//other languages...
<option value="**">{localize(lang, 'com_nav_lang_your-language-name')}</option>
</select>
</div>
);
};
```
where ** is the ISO 3166 Alpha-2 code and "com_nav_lang_your-language-name" stands for the name in your language (for example com_nav_lang_english or com_nav_lang_italian)
The only line of code to add is:
`<option value="**">{localize(lang, 'com_nav_lang_your-language-name')}</option>`
11. Commit your changes using git add *, git commit -m "Language translation: your-language translation" and git push.
12. Open your repository in a browser and click on "Contribute"
![image](https://github.com/Berry-13/LibreChat/assets/81851188/ab91cf4b-1830-4419-9d0c-68fcb2fd5f5e)
14. Answer all the questions, and in the "Type of Change" section, add `- [x] Translation support`
15. Create a pull request 🎉