Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pie-framework/pie-lib
Some reusable react libraries
https://github.com/pie-framework/pie-lib
Last synced: about 2 months ago
JSON representation
Some reusable react libraries
- Host: GitHub
- URL: https://github.com/pie-framework/pie-lib
- Owner: pie-framework
- License: isc
- Created: 2018-03-06T17:38:26.000Z (almost 7 years ago)
- Default Branch: develop
- Last Pushed: 2024-10-29T09:53:40.000Z (4 months ago)
- Last Synced: 2024-10-29T10:01:41.525Z (4 months ago)
- Language: JavaScript
- Homepage: https://pie-lib.now.sh
- Size: 16.8 MB
- Stars: 4
- Watchers: 5
- Forks: 4
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# @pie-lib/\*
[](https://circleci.com/gh/pie-framework/pie-lib)
Some reusable react components, mostly used in [pie][pie] components.
Elements are in `packages`.
## install
```bash
yarn install
./node_modules/.bin/lerna bootstrap
```
## Commands
| Action | Cmd | Notes |
| ------- | ----------------------------------- | --------------------------------------------------------- |
| test | `npm test` | |
| lint | `npm run lint` | |
| build | `npm run build` | |
| release | `npm run release` | |
| dev | `scripts/dev --scope $package-name` | run the demo site on localhost:3000 `--scope` if optional |
| static | `scripts/wip $alias-name` | build and deploy the static site tno now.sh |
## Workflow
- merging to `develop` releases `next` versions and deploys to `pie-lib-next.now.sh`
- merging to `master` releases `latest` versions and deploys to `pie-lib.now.sh`
### test a single package
Just point jest to the dir/file:
```bash
./node_modules/.bin/jest packages/pkg-name/src/
```
## contributing
- the packages use `independent` versioning, meaning that a change in 1 package won't bump another package's version.
- use [conventional commits syntax][ccs] when commiting, lerna will detect the appropriate version bump.
### rebase
To skip husky during a rebase do:
```shell
HUSKY_SKIP_HOOKS=1 git rebase ...
```
### dependencies
[lerna]: https://lernajs.io/
[pie]: http://pie-framework.org
[ccs]: https://conventionalcommits.org/
## Test issues
Sometimes the project test set up can get out of synch
- try `lerna bootstrap`, `npm run build`, `rm -fr packages/test-utils/node_modules` and run again.
## Building and deploying a pre-release
```shell
# make sure the local demo is working first: scripts/dev then:
./node_modules/.bin/next build packages/demo
./node_modules/.bin/next export packages/demo
cd out
# you can now deploy using now (or if you have another static site handler)
now .
```
#
## Linking pslb
You'll have to run the link commands in the pslb repo, then you can run
```shell
yarn clean-install && yarn link-pslb && yarn print-module
```