@bspk/ui-ngx 0.0.4 → 1.0.0

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.
Files changed (2) hide show
  1. package/README.md +45 -12
  2. package/package.json +2 -2
package/README.md CHANGED
@@ -1,31 +1,64 @@
1
- # Bespoke UI-NGX
1
+ # Ui
2
2
 
3
- Bespoke UI NGX package contains all the angular components that are available for Anywhere Real Estate development teams.
3
+ This project was generated using [Angular CLI](https://github.com/angular/angular-cli) version 20.3.0.
4
4
 
5
- https://bspk.anywhere.re
5
+ ## Code scaffolding
6
6
 
7
- ## Installation
7
+ Angular CLI includes powerful code scaffolding tools. To generate a new component, run:
8
8
 
9
9
  ```bash
10
- npm install @bspk/ui-ngx
10
+ ng generate component component-name
11
11
  ```
12
12
 
13
+ For a complete list of available schematics (such as `components`, `directives`, or `pipes`), run:
14
+
13
15
  ```bash
14
- npm install --peer @bspk/styles @floating-ui/dom
16
+ ng generate --help
15
17
  ```
16
18
 
17
- ## Testing
19
+ ## Building
18
20
 
19
- To test all components
21
+ To build the library, run:
20
22
 
21
23
  ```bash
22
- npm run test
24
+ ng build ui
23
25
  ```
24
26
 
25
- To test a specific component
27
+ This command will compile your project, and the build artifacts will be placed in the `dist/` directory.
28
+
29
+ ### Publishing the Library
30
+
31
+ Once the project is built, you can publish your library by following these steps:
32
+
33
+ 1. Navigate to the `dist` directory:
34
+
35
+ ```bash
36
+ cd dist/ui
37
+ ```
38
+
39
+ 2. Run the `npm publish` command to publish your library to the npm registry:
40
+ ```bash
41
+ npm publish
42
+ ```
43
+
44
+ ## Running unit tests
45
+
46
+ To execute unit tests with the [Karma](https://karma-runner.github.io) test runner, use the following command:
26
47
 
27
48
  ```bash
28
- npm run test <componentname>
49
+ ng test
29
50
  ```
30
51
 
31
- <!--- Copyright 2026 Anywhere Real Estate - CC BY 4.0 -->
52
+ ## Running end-to-end tests
53
+
54
+ For end-to-end (e2e) testing, run:
55
+
56
+ ```bash
57
+ ng e2e
58
+ ```
59
+
60
+ Angular CLI does not come with an end-to-end testing framework by default. You can choose one that suits your needs.
61
+
62
+ ## Additional Resources
63
+
64
+ 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.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@bspk/ui-ngx",
3
- "version": "0.0.4",
3
+ "version": "1.0.0",
4
4
  "peerDependencies": {
5
5
  "@angular/common": "^20.3.0",
6
6
  "@angular/core": "^20.3.0",
@@ -28,4 +28,4 @@
28
28
  },
29
29
  "module": "fesm2022/bspk-ui-ngx.mjs",
30
30
  "typings": "index.d.ts"
31
- }
31
+ }