@ivao/atmosphere-react 0.1.0-next.2 → 0.1.0-next.4
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 +22 -0
- package/dist/atmosphere-react.js +5775 -5660
- package/dist/atmosphere-react.js.map +1 -1
- package/dist/react-components.d.ts +10 -1
- package/dist/styles/index.css +1 -1
- package/package.json +12 -2
- package/src/styles/index.css +38 -7
package/README.md
CHANGED
|
@@ -23,3 +23,25 @@ Import our CSS by adding this line to your index file.
|
|
|
23
23
|
```typescript
|
|
24
24
|
import '@ivao/atmosphere-react/dist/styles/index.css';
|
|
25
25
|
```
|
|
26
|
+
|
|
27
|
+
## Contributing
|
|
28
|
+
|
|
29
|
+
### Testing Locally on another repo
|
|
30
|
+
|
|
31
|
+
You can use Storybook to see how the components look, however it's recommended to also test it on a more real environment as a new repo.
|
|
32
|
+
|
|
33
|
+
1. Run `pnpm dev:react:build` to build the library.
|
|
34
|
+
2. To use it on another repo, there are multiple ways, but one of the simplest ones is running
|
|
35
|
+
|
|
36
|
+
```bash
|
|
37
|
+
pnpm dev:react:pack
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
This command creates a `.tgz` file on the root of the `/components/react` folder. Copy the name of that file.
|
|
41
|
+
|
|
42
|
+
3. To use it on your repo, add this line to your `package.json`. Replace the `.tgz` file name.
|
|
43
|
+
|
|
44
|
+
```json
|
|
45
|
+
"@ivao/atmosphere-react": "file:../atmosphere/components/react/ivao-atmosphere-react-0.1.0-next.2.tgz",
|
|
46
|
+
|
|
47
|
+
```
|