# yc-i18n-gui

> Graphical user interface for editing `i18n` files. The main use is assumed with https://github.com/yandex-cloud/i18n.

Latest version **1.1.0** (published 2022-08-28) · MIT license · 0 weekly downloads

## Install

```sh
npm install yc-i18n-gui
pnpm add yc-i18n-gui
yarn add yc-i18n-gui
bun add yc-i18n-gui
```

Provides the command `yc-i18n-gui`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; large bundle.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.0 |
| Published | 2022-08-28 |
| First published | 2022-04-29 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 10.3 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Author | Isaev Alexandr |
| Maintainers | isaevalexandr |

## Links

- npm: https://www.npmjs.com/package/yc-i18n-gui
- Repository: https://github.com/IsaevAlexandr/yc-i18n-gui
- Homepage: https://github.com/IsaevAlexandr/yc-i18n-gui#readme
- Issues: https://github.com/IsaevAlexandr/yc-i18n-gui/issues
- npm.io page: https://npm.io/package/yc-i18n-gui

## Recent versions

- 1.1.0 (latest) — 2022-08-28
- 1.0.0 — 2022-04-30
- 0.2.0 — 2022-04-29
- 0.1.0 — 2022-04-29

## README

# yc-i18n-gui

Graphical user interface for editing `i18n` files. The main use is assumed with https://github.com/yandex-cloud/i18n.

It is a tool for local editing files through the file system adapter. With certain modifications (db adapter), it can be used as a standalone client-server application

![gui-example](https://user-images.githubusercontent.com/27916444/166114201-dab61f5c-8250-4d5f-a398-111cacb5ddbe.gif)

![result-example](https://user-images.githubusercontent.com/27916444/166114104-0e37cc52-a909-404b-899a-8a81091eb31e.gif)

## Quick start:

```sh
npx yc-i18n-gui
```

## Usage as a project dependency

1. add package as a dev-dependency

   ```sh
   npm i -D yc-i18n-gui
   ```

2. add script in `package.json`:

   ```diff
   {
   ...
        "scripts": {
            ...
   +        "yc-i18n-gui": "KEYSETS_DIR_PATH=src/keysets npm run yc-i18n-gui"
        }
   }
   ```

3. run script:

   ```sh
   npm run yc-i18n-gui
   ```

## Env variables:

- `KEYSETS_DIR_PATH` - specify keyset directory;
- `PORT` - on which port the server with the application will be launched; Default - `3000`;

## Hint:

- If you use a dev-server for development with configured nginx, after launching, the application will be available on `http://<you-dev-server-host>:<PORT>`. Just open it in a browser that supports `http` connections, for example `Firefox`

---
_Source: https://npm.io/package/yc-i18n-gui · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._