keys-translations-manager - GitLite

KO | EN

gitlite — search

#python #hacktoberfest #ai #typescript #llm #machine-learning #rust #nodejs #windows #vue #pytorch #ios #openai #open-source

keys-translations-manager

(★ 101)

[MERN Stack] KTM, a locale management web app, lets you manage and control locales in one place. Useful for multiple i18n/l10n projects.

파일 탐색기

최종 버전 다운로드 (.zip)

- cli-v1.0.md
- history.md
- import.md
- merge.md
- rest-api.md
- vis.md
- app.less
- - .npmignore
  - package.json
  - README.md
- - index.js
  - package.json
  - README.md
- - favicon.ico
- - components.js
  - counts.js
  - errors.js
  - history.js
  - keys.js
  - messages.js
  - socket.js
  - translations.js
  - vis.js
- - index.js
- - ActionTypes.js
  - InitStates.js
  - Languages.js
  - Status.js
- - RootContainer.js
  - VisContainer.js
- - CountController.js
  - DownloadController.js
  - HistoryController.js
  - ImportController.js
  - KeyController.js
  - TranslationController.js
  - VisController.js
- - HistoryModel.js
  - TranslationModel.js
- - components.js
  - counts.js
  - errors.js
  - history.js
  - index.js
  - messages.js
  - socket.js
  - translations.js
  - vis.js
- - index.js
- - configureStore.js
- App.jsx
- configUtil.js
- - translation
  - translation.json
  - translation.properties
- testHelper.js
- index.ejs
.babelrc
.codecov.yml
.dockerignore
.editorconfig
.eslintignore
.eslintrc
.gitignore
.nycrc
.travis.yml
appveyor.yml
CHANGELOG.md
db.config.js
docker-compose.yml
Dockerfile
ktm.config.js
ktm.server.config.js
LICENSE
nodemon.json
package.json
README.md
Server.js
webpack.config.dev.js
webpack.config.prod.js
yarn.lock

# 설치 가이드

1. 코드 내려받기

git clone https://github.com/chejen/keys-translations-manager

깃허브에서 프로젝트 코드 전체를 내 컴퓨터로 내려받습니다.

cd keys-translations-manager

방금 내려받은 프로젝트 폴더 안으로 이동합니다.

2. Docker

쉬움 추천

사전 준비물

Git GitHub에서 프로젝트 코드를 내려받으려면 필요합니다.
Docker Desktop 컨테이너를 빌드하고 실행하려면 필요합니다. 설치 후 실행해서 백그라운드에 켜두세요.

$ docker-compose up -d

compose 설정 파일에 정의된 서비스들을 대상으로 명령을 실행합니다.

✅ 터미널에 docker compose ps 를 입력해 컨테이너들이 Up 상태인지 확인하세요. README에 포트 번호가 적혀있다면 브라우저에서 http://localhost:포트번호 로 접속해보세요.

이 레포의 README에 적힌 실제 명령어를 그대로 가져왔습니다.

3. Node.js

쉬움

사전 준비물

Git GitHub에서 프로젝트 코드를 내려받으려면 필요합니다.
Node.js npm 명령어를 쓰려면 Node.js가 설치되어 있어야 합니다. LTS(장기지원) 버전을 추천합니다.

$ npm install (or yarn install)

package.json에 명시된 라이브러리들을 내려받아 설치합니다.

$ npm run build (or yarn build)

배포용으로 코드를 최적화해서 빌드 파일을 생성합니다.

$ npm start (or yarn start)

개발/실행 서버를 켭니다.

✅ 명령어 실행 후 터미널에 나타나는 주소(보통 http://localhost:3000 형태)를 브라우저에서 열어보세요.

이 레포의 README에 적힌 실제 명령어를 그대로 가져왔습니다.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

<p align="center">
  <img src="https://cloud.githubusercontent.com/assets/14872888/21645988/5160c954-d2cf-11e6-8a09-2c64cf6f62c4.png"/>
</p>

[![MIT Licensed][license-image]][license-url]
[![Build Status (Windows)][appveyor-image]][appveyor-url]
[![Build Status (Linux)][travis-image]][travis-url]
[![Coverage Status][codecov-image]][codecov-url]

[license-image]: https://img.shields.io/badge/license-MIT-blue.svg
[license-url]: https://github.com/chejen/keys-translations-manager/blob/master/LICENSE
[appveyor-image]: https://img.shields.io/appveyor/ci/chejen/keys-translations-manager/master.svg?logo=data%3Aimage%2Fsvg%2Bxml%3Bbase64%2CPHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZlcnNpb249IjEuMSIgd2lkdGg9IjEyOCIgaGVpZ2h0PSIxMjgiIHZpZXdCb3g9IjAgMCAxMjggMTI4Ij48ZyBmaWxsPSIjMUJBMUUyIiB0cmFuc2Zvcm09InNjYWxlKDgpIj48cGF0aCBkPSJNMCAyLjI2NWw2LjUzOS0uODg4LjAwMyA2LjI4OC02LjUzNi4wMzd6Ii8%2BPHBhdGggZD0iTTYuNTM2IDguMzlsLjAwNSA2LjI5My02LjUzNi0uODk2di01LjQ0eiIvPjxwYXRoIGQ9Ik03LjMyOCAxLjI2MWw4LjY3LTEuMjYxdjcuNTg1bC04LjY3LjA2OXoiLz48cGF0aCBkPSJNMTYgOC40NDlsLS4wMDIgNy41NTEtOC42Ny0xLjIyLS4wMTItNi4zNDV6Ii8%2BPC9nPjwvc3ZnPg==
[appveyor-url]: https://ci.appveyor.com/project/chejen/keys-translations-manager
[travis-image]: https://img.shields.io/travis/chejen/keys-translations-manager/master.svg?logo=data%3Aimage%2Fsvg%2Bxml%3Bbase64%2CPHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHhtbG5zOnhsaW5rPSJodHRwOi8vd3d3LnczLm9yZy8xOTk5L3hsaW5rIiB2aWV3Qm94PSItMTQyLjUgLTE0Mi41IDI4NSAyODUiPjxjaXJjbGUgcj0iMTQxLjciIGZpbGw9IiNERDQ4MTQiLz48ZyBpZD0iYSIgZmlsbD0iI0ZGRiI%2BPGNpcmNsZSBjeD0iLTk2LjQiIHI9IjE4LjkiLz48cGF0aCBkPSJNLTQ1LjYgNjguNGMtMTYuNi0xMS0yOS0yOC0zNC00Ny44IDYtNSA5LjgtMTIuMyA5LjgtMjAuNnMtMy44LTE1LjctOS44LTIwLjZjNS0xOS44IDE3LjQtMzYuNyAzNC00Ny44bDEzLjggMjMuMkMtNDYtMzUuMi01NS4zLTE4LjctNTUuMyAwYzAgMTguNyA5LjMgMzUuMiAyMy41IDQ1LjJ6Ii8%2BPC9nPjx1c2UgeGxpbms6aHJlZj0iI2EiIHRyYW5zZm9ybT0icm90YXRlKDEyMCkiLz48dXNlIHhsaW5rOmhyZWY9IiNhIiB0cmFuc2Zvcm09InJvdGF0ZSgyNDApIi8%2BPC9zdmc%2B
[travis-url]: https://travis-ci.org/chejen/keys-translations-manager
[codecov-image]: https://codecov.io/github/chejen/keys-translations-manager/coverage.svg?branch=master
[codecov-url]: https://codecov.io/github/chejen/keys-translations-manager?branch=master

# Keys-Translations Manager

[Demo](#demo) |
[Key Features](#key-features) |
[Getting Started](#getting-started) |
[Custom](#custom) |
[Technologies](#technologies) |
[License](#license) |
[Questions?](#questions)

> Keys-Translations Manager, a web application scaffolded with MERN stack, aims to facilitate locale management. With this application, you can:
> * control and manage locales in one place,
> * import locales from nested/flat JSON or Properties files,
> * export locales to nested/flat JSON or Properties files,
> * view revision history of every single key,
> * get data validation for input/import, and
> * get real-time notifications if data has been changed by the other users.

## Demo
![demo](https://user-images.githubusercontent.com/14872888/46092875-6f60fa00-c1e8-11e8-94f8-4de1134e6a63.gif)

## Key Features
#### Import locales
Transfer your locales from separate files to Keys-Translations Manager to make them easy to read, convenient to collaborate, and maintainable. (See [instructions][16])

#### Export locales
Not only can you download locales directly from the web, but you can also get them via [CLI][15] or [REST API][17].

#### Merge translations
Keys-Translations Manager can help you to merge the same keys that have the same translations for each locale but sit in different projects. (See [instructions][18])

#### View revision history
See the [demo][19]

#### Visualization
See the [demo][20]

## Getting Started
#### Method 1:
* Download [Node.js](https://nodejs.org/en/) (v10.13+ is required) and [MongoDB](https://www.mongodb.org/), and then get them installed.
* Start [mongod](https://docs.mongodb.org/manual/tutorial/manage-mongodb-processes/) process and make sure it's running normally.
* Checkout this repo (or directly download the stable releases from [here](https://github.com/chejen/keys-translations-manager/releases)), install dependencies, then start the web server:
```sh
$ git clone https://github.com/chejen/keys-translations-manager
$ cd keys-translations-manager
$ npm install (or yarn install)
$ npm run build (or yarn build)
$ npm start (or yarn start)
```

Open http://localhost:3000/ and enjoy it.

#### Method 2:
Alternatively, if you have Docker and docker-compose installed:
```sh
$ git clone https://github.com/chejen/keys-translations-manager
$ cd keys-translations-manager
$ docker-compose up -d
```

Open http://localhost:3000/ and enjoy it.

## Custom
There are several environment variables you can configure:

| **Variable** | **Description** |**Default**|
|----------|-------|---|
|  PORT  |   Web server's port    | ```3000```  |
|  DB  |   MongoDB connection URI    | ```mongodb://localhost:27017/translationdb```  |

There are some other settings (in [ktm.config.js](./ktm.config.js)) you can configure. The table below lists the available ones:

| **Setting** | **Description** |**Default**|
|----------|-------|---|
|  locales  |   The locales need to be managed. (You can add or remove locales arbitrarily.)    | ```['en-US', 'zh-TW']```  |
|  projects  |   The projects need to be localized. (You can add or remove projects arbitrarily.)    | ```[ {id:'p1', name:'project A'}, {id:'p2', name:'project B'} ]```  |
|  enableNotifications  |   Push real-time notifications to users    | ```true```  |

> Note:
> Rebuild the code (```npm run build``` or ```yarn build```) and restart the server if you change any of these configurations.
> Or, if you run the app in containers, run ```docker-compose build``` and then ```docker-compose up -d```.

## Technologies
* Scaffolded with [MongoDB][1], [Express][2], [React][3], and [Node.js][4]
* Styled with [Bootstrap][5] (theme: [SB Admin 2][6]) and [Less][7]
* Visualization: [D3][8]
* Real-Time Notifications: [Socket.IO][21]
* Virtualization: [Docker][22]
* Module Bundler: [webpack][9]
* Unit Testing: [Mocha][10], [Chai][11] and [Enzyme][12]
* Miscellaneous: [Babel][13], [ESLint][14]

## License
This source code is licensed under the [MIT License](http://www.opensource.org/licenses/MIT).

## Questions?
Please don't hesitate to [open an issue](https://github.com/chejen/keys-translations-manager/issues/new) or [contact me](mailto:jkopre.qek@gmail.com).

[1]: https://www.mongodb.org/
[2]: http://expressjs.com/
[3]: https://facebook.github.io/react/
[4]: https://nodejs.org/en/
[5]: http://getbootstrap.com/
[6]: http://startbootstrap.com/template-overviews/sb-admin-2/
[7]: http://lesscss.org/
[8]: https://d3js.org/
[9]: https://webpack.github.io/
[10]: https://mochajs.org/
[11]: http://chaijs.com/
[12]: http://airbnb.io/enzyme/
[13]: https://babeljs.io/
[14]: http://eslint.org/
[15]: https://github.com/chejen/keys-translations-manager/tree/master/packages/keys-translations-manager-cli
[16]: https://github.com/chejen/keys-translations-manager/blob/master/docs/import.md
[17]: https://github.com/chejen/keys-translations-manager/blob/master/docs/rest-api.md
[18]: https://github.com/chejen/keys-translations-manager/blob/master/docs/merge.md
[19]: https://github.com/chejen/keys-translations-manager/blob/master/docs/history.md
[20]: https://github.com/chejen/keys-translations-manager/blob/master/docs/vis.md
[21]: http://socket.io/
[22]: https://www.docker.com/