1
1
[ ![ npm version] ( https://badge.fury.io/js/%40novyk%2Fngxe.svg )] ( https://www.npmjs.com/@novyk/ngxe )
2
2
![ CI] ( https://github.com/navix/ngxe/actions/workflows/ci.yml/badge.svg )
3
3
4
- # 📜 ngxe (currently in BETA)
4
+ # 📜 ngxe
5
5
6
6
Angular 11.1+ JSON Translations Editor.
7
7
8
+ A simple UI for your translations: hosted on NPM, runs on your dev machine.
9
+
10
+ ### Features
11
+
12
+ * Works directly with your files, no additional routine.
13
+ * Any number of locales.
14
+ * Diff changes.
15
+ * Filters, handy pagination.
16
+ * Suggestions based on similar sources.
17
+ * Themes: light, solarized, dark.
18
+
19
+ ### [ The front app demo — ngxe.oleksanovyk.com] ( https://ngxe.oleksanovyk.com/ )
20
+
21
+ ![ ngxe screenshop] ( ./screenshot.png )
22
+
23
+
8
24
## Installation
9
25
10
26
```
11
- $ npm i @novyk/ngxe@beta -D
27
+ $ npm i @novyk/ngxe -D
12
28
```
13
29
30
+
14
31
## Usage
15
32
16
33
#### Create ` ngxe.json ` config file in the root:
@@ -32,16 +49,16 @@ $ npm i @novyk/ngxe@beta -D
32
49
```
33
50
34
51
* ` input ` - file generated by Angular, you can add it to ` .gitignore `
35
- * ` output.source ` - copy of the input file but ordered by keys (need for further transitions and smooth committing to Git).
52
+ * ` output.source ` - copy of the input file, but ordered by keys (need for further transitions and smooth committing to Git).
36
53
* ` output.translations ` - target locales.
37
54
38
55
#### Extract translations from your project in JSON format:
39
56
40
57
```
41
- $ ng xi18n --format=json
58
+ $ ng extract-i18n --format=json
42
59
```
43
60
44
- Editor works best if i18n messages have IDs:
61
+ The editor works best if i18n messages have IDs, but it is not necessary :
45
62
46
63
```
47
64
<div i18n="@@MSG_ID">Message with ID</div>
@@ -55,7 +72,7 @@ $localize`:@@MSG_ID_2:Message with ID 2`;
55
72
$ npx ngxe
56
73
```
57
74
58
- Browser should open the app (http://localhost:7600/ngxe/index.html ).
75
+ Browser should open the app (http://localhost:7600/ ).
59
76
60
77
Use the ngxe app to update messages and press ` Save Project ` (all ` output ` files will be updated).
61
78
0 commit comments