mirror of
https://github.com/Start9Labs/start-os.git
synced 2026-03-26 10:21:52 +00:00
116 lines
3.5 KiB
Markdown
116 lines
3.5 KiB
Markdown
# Contributing to StartOS Web
|
|
|
|
For general environment setup (Node.js, cloning, etc.), see the root [CONTRIBUTING.md](../CONTRIBUTING.md).
|
|
|
|
## Web Setup
|
|
|
|
```sh
|
|
cd web
|
|
npm ci
|
|
npm run build:deps
|
|
```
|
|
|
|
#### Configure `config.json`
|
|
|
|
```sh
|
|
cp config-sample.json config.json
|
|
```
|
|
|
|
- By default, "useMocks" is set to `true`.
|
|
- Use "maskAs" to mock the host from which the web UI is served. Valid values are `tor`, `local`, `localhost`, `ipv4`, `ipv6`, and `clearnet`.
|
|
- Use "maskAsHttps" to mock the protocol over which the web UI is served. `true` means https; `false` means http.
|
|
|
|
## Development Server
|
|
|
|
You can develop using mocks (recommended to start) or against a live server. Code changes will live reload the browser.
|
|
|
|
### Using mocks
|
|
|
|
```sh
|
|
npm run start:setup
|
|
npm run start:ui
|
|
```
|
|
|
|
### Proxying to a live server
|
|
|
|
1. In `config.json`, set "useMocks" to `false`
|
|
|
|
2. Copy and configure the proxy config:
|
|
|
|
```sh
|
|
cp proxy.conf-sample.json proxy.conf.json
|
|
```
|
|
|
|
3. Replace every instance of `<CHANGEME>` with the hostname of your remote server
|
|
|
|
4. Start the proxy dev server:
|
|
|
|
```sh
|
|
npm run start:ui:proxy
|
|
```
|
|
|
|
## Translations
|
|
|
|
### Currently supported languages
|
|
|
|
- English
|
|
- Spanish
|
|
- Polish
|
|
- German
|
|
- French
|
|
<!-- - Korean
|
|
- Russian
|
|
- Japanese
|
|
- Hebrew
|
|
- Arabic
|
|
- Mandarin
|
|
- Hindi
|
|
- Portuguese
|
|
- Italian
|
|
- Thai -->
|
|
|
|
### Adding a new translation
|
|
|
|
When prompting AI to translate the English dictionary, it is recommended to only give it 50-100 entries at a time. Beyond that it struggles. Remember to sanity check the results and ensure keys/values align in the resulting dictionary.
|
|
|
|
#### Sample AI prompt
|
|
|
|
Translate the English dictionary below into `<language>`. Format the result as a javascript object with the numeric values of the English dictionary as keys in the translated dictionary. These translations are for the web UI of StartOS, a graphical server operating system optimized for self-hosting. Comments may be included in the English dictionary to provide additional context.
|
|
|
|
#### Adding to StartOS
|
|
|
|
- In the `shared` project:
|
|
1. Create a new file (`language.ts`) in `src/i18n/dictionaries`
|
|
2. Update the `I18N_PROVIDERS` array in `src/i18n/i18n.providers.ts` (2 places)
|
|
3. Update the `languages` array in `/src/i18n/i18n.service.ts`
|
|
4. Add the name of the new language (lowercase) to the English dictionary in `src/i18n/dictionaries/en.ts`. Add the translations of the new language's name (lowercase) to ALL non-English dictionaries in `src/i18n/dictionaries/` (e.g., `es.ts`, `pl.ts`, etc.).
|
|
|
|
If you have any doubt about the above steps, check the [French example PR](https://github.com/Start9Labs/start-os/pull/2945/files) for reference.
|
|
|
|
- Here in this CONTRIBUTING.md:
|
|
1. Add the language to the list of supported languages above
|
|
|
|
### Updating the English dictionary
|
|
|
|
#### Sample AI prompt
|
|
|
|
Translate the English dictionary below into the languages beneath the dictionary. Format the result as a javascript object with translated language as keys, mapping to a javascript object with the numeric values of the English dictionary as keys and the translations as values. These translations are for the web UI of StartOS, a graphical server operating system optimized for self-hosting. Comments may be included in the English dictionary to provide additional context.
|
|
|
|
English dictionary:
|
|
|
|
```
|
|
'Hello': 420,
|
|
'Goodby': 421
|
|
```
|
|
|
|
Languages:
|
|
|
|
- Spanish
|
|
- Polish
|
|
- German
|
|
- French
|
|
|
|
#### Adding to StartOS
|
|
|
|
In the `shared` project, copy/paste the translations into their corresponding dictionaries in `/src/i18n/dictionaries`.
|