@usssa/component-library 1.0.0-alpha.1 → 1.0.0-alpha.2
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 +15 -37
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,54 +1,32 @@
|
|
|
1
|
-
# Prerequesites
|
|
2
|
-
|
|
3
|
-
1. 'quasar' should be installed in the project using the library
|
|
4
|
-
|
|
5
|
-
2. Your package.json should include the pacakge in the dependencies like this:
|
|
6
|
-
|
|
7
|
-
```
|
|
8
|
-
dependencies: {
|
|
9
|
-
@usssa-org/component-library: 'latest'
|
|
10
|
-
}
|
|
11
|
-
```
|
|
12
|
-
3. Your .npmrc file in the root of the project should look like this:
|
|
13
|
-
|
|
14
|
-
```
|
|
15
|
-
{
|
|
16
|
-
shamefully-hoist=true
|
|
17
|
-
strict-peer-dependencies=false
|
|
18
|
-
resolution-mode=highest
|
|
19
|
-
@usssa-org:registry = https://npm.pkg.github.com/
|
|
20
|
-
//npm.pkg.github.com/:_authToken=<YOUR_GITHUB_TOKEN>
|
|
21
|
-
}
|
|
22
|
-
```
|
|
23
|
-
## Install the dependencies
|
|
24
|
-
|
|
25
|
-
```bash
|
|
26
|
-
yarn
|
|
27
|
-
```
|
|
28
|
-
|
|
29
|
-
### Start the app in development mode (hot-code reloading, error reporting, etc.)
|
|
30
|
-
|
|
31
|
-
```bash
|
|
32
|
-
quasar dev
|
|
33
|
-
```
|
|
34
|
-
|
|
35
1
|
# Component Library
|
|
36
2
|
|
|
37
|
-
This library provides custom
|
|
3
|
+
This library provides custom UI components for USSSA applications.
|
|
38
4
|
|
|
39
|
-
|
|
5
|
+
## Installation
|
|
40
6
|
|
|
41
7
|
1. Install the packge using command 'yarn'
|
|
42
8
|
2. Go to specific page where you want to use a component from that library.
|
|
43
9
|
a. Import the library in your Quasar project: `import { UBtnStd } from 'component-library'`
|
|
44
10
|
b. Use the BtnStd component in your Nuxt app: `<UBtnStd label="Test" size="lg" />`
|
|
45
11
|
|
|
46
|
-
|
|
12
|
+
## Development
|
|
13
|
+
|
|
14
|
+
```bash
|
|
15
|
+
# Clone with appropriate credentials
|
|
16
|
+
git clone https://github.com/usssa-org/component-library
|
|
17
|
+
|
|
18
|
+
cd component-library
|
|
19
|
+
yarn install
|
|
20
|
+
yarn dev
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
## Usage in other local projects
|
|
47
24
|
|
|
48
25
|
1. Clone the component-library repo and install dependencies
|
|
49
26
|
2. In component-library directory run `yarn link`
|
|
50
27
|
3. In Nuxt or Quasar project directory run `yarn link @usssa/component-library`
|
|
51
28
|
|
|
52
29
|
When done:
|
|
30
|
+
|
|
53
31
|
1. In Nuxt or Quasar project directory run `yarn unlink @usssa/component-library`
|
|
54
32
|
2. In component-library directory run `yarn unlink`
|
package/package.json
CHANGED