brainloper-ui 14.0.4 → 14.0.5
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 +36 -2
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,3 +1,37 @@
|
|
|
1
|
-
|
|
1
|
+
## Steps to Publish the Library
|
|
2
2
|
|
|
3
|
-
1.
|
|
3
|
+
1. **Run the publish script**:
|
|
4
|
+
- Open a terminal in the root directory of the project.
|
|
5
|
+
- Execute the following command:
|
|
6
|
+
|
|
7
|
+
```sh
|
|
8
|
+
npm run publish
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Steps to Test the Library Locally
|
|
12
|
+
|
|
13
|
+
To test the library locally without publishing it, you can use `npm pack`. Follow these steps:
|
|
14
|
+
|
|
15
|
+
1. **Package the library**:
|
|
16
|
+
- Open a terminal in the root directory of the library.
|
|
17
|
+
- Execute the following commands:
|
|
18
|
+
|
|
19
|
+
```sh
|
|
20
|
+
npm run packagr
|
|
21
|
+
npm pack ./dist/
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
This will generate a `.tgz` file in the root proyect
|
|
25
|
+
|
|
26
|
+
2. **Install the package in your project**:
|
|
27
|
+
- Copy the generated `.tgz` file to the root directory of your project.
|
|
28
|
+
- Open a terminal in the root directory of your project.
|
|
29
|
+
- Execute the following command:
|
|
30
|
+
|
|
31
|
+
```sh
|
|
32
|
+
npm install ../brainloper-ui/brainloper-ui-14.0.4.tgz --force
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
Replace [`../brainloper-ui/brainloper-ui-14.0.4.tgz`] with the correct path to the `.tgz` file.
|
|
36
|
+
|
|
37
|
+
By following these steps, you can test your library locally without needing to publish it to npm.
|