@openkit-labs/ngx-kit-ui 0.0.28 → 0.0.30
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +14 -48
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,63 +1,29 @@
|
|
|
1
|
-
# NgxUiKit
|
|
2
1
|
|
|
3
|
-
This project was generated using [Angular CLI](https://github.com/angular/angular-cli) version 19.2.0.
|
|
4
2
|
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
Angular CLI includes powerful code scaffolding tools. To generate a new component, run:
|
|
3
|
+
# NGX Kit UI
|
|
4
|
+
### Modern Angular UI kit for mobile and web
|
|
8
5
|
|
|
6
|
+
### Installation
|
|
9
7
|
```bash
|
|
10
|
-
ng generate component component-name
|
|
11
|
-
```
|
|
12
8
|
|
|
13
|
-
|
|
9
|
+
npm install @openkit-labs/ngx-kit-ui
|
|
14
10
|
|
|
15
|
-
```bash
|
|
16
|
-
ng generate --help
|
|
17
11
|
```
|
|
18
12
|
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
To build the library, run:
|
|
22
|
-
|
|
23
|
-
```bash
|
|
24
|
-
ng build ngx-kit-ui
|
|
25
|
-
```
|
|
26
|
-
|
|
27
|
-
This command will compile your project, and the build artifacts will be placed in the `dist/` directory.
|
|
28
|
-
|
|
29
|
-
### Publishing the Library
|
|
13
|
+
### Documentation
|
|
30
14
|
|
|
31
|
-
|
|
15
|
+
Visit the documentation page: [Documentation & Examples](https://openkit-labs.github.io/ngx-kit-ui/home)
|
|
32
16
|
|
|
33
|
-
|
|
34
|
-
```bash
|
|
35
|
-
cd dist/ngx-kit-ui
|
|
36
|
-
```
|
|
37
|
-
|
|
38
|
-
2. Run the `npm publish` command to publish your library to the npm registry:
|
|
39
|
-
```bash
|
|
40
|
-
npm publish
|
|
41
|
-
```
|
|
42
|
-
|
|
43
|
-
## Running unit tests
|
|
44
|
-
|
|
45
|
-
To execute unit tests with the [Karma](https://karma-runner.github.io) test runner, use the following command:
|
|
17
|
+
### Development
|
|
46
18
|
|
|
47
19
|
```bash
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
## Running end-to-end tests
|
|
20
|
+
# clone repository
|
|
21
|
+
git clone https://github.com/OpenKit-Labs/ngx-kit-ui.git
|
|
22
|
+
cd ngx-kit-ui
|
|
52
23
|
|
|
53
|
-
|
|
24
|
+
# install dependencies
|
|
25
|
+
npm install
|
|
54
26
|
|
|
55
|
-
|
|
56
|
-
ng
|
|
27
|
+
# run the demo app from the repo root and open the browser at http://localhost:4199
|
|
28
|
+
ng serve
|
|
57
29
|
```
|
|
58
|
-
|
|
59
|
-
Angular CLI does not come with an end-to-end testing framework by default. You can choose one that suits your needs.
|
|
60
|
-
|
|
61
|
-
## Additional Resources
|
|
62
|
-
|
|
63
|
-
For more information on using the Angular CLI, including detailed command references, visit the [Angular CLI Overview and Command Reference](https://angular.dev/tools/cli) page.
|