mirror of
https://github.com/pezkuwichain/pezkuwi-ui.git
synced 2026-04-21 23:47:58 +00:00
chore: update README and workflows for PezkuwiChain rebrand
- Update README with Dijital Kurdistan Tech Institute author - Fix lock.yml to use github.token instead of GH_PAT_BOT - Rename push-master.yml to push-main.yml for main branch - Add workflow_dispatch triggers for manual runs
This commit is contained in:
@@ -1,18 +1,17 @@
|
|||||||
name: 'Lock Threads'
|
name: 'Lock Threads'
|
||||||
|
|
||||||
on:
|
on:
|
||||||
|
workflow_dispatch:
|
||||||
schedule:
|
schedule:
|
||||||
- cron: '25 2/3 * * *'
|
- cron: '25 2/3 * * *'
|
||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
lock:
|
lock:
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
env:
|
|
||||||
YARN_ENABLE_SCRIPTS: false
|
|
||||||
steps:
|
steps:
|
||||||
- uses: dessant/lock-threads@c1b35aecc5cdb1a34539d14196df55838bb2f836
|
- uses: dessant/lock-threads@v5
|
||||||
with:
|
with:
|
||||||
github-token: ${{ secrets.GH_PAT_BOT }}
|
github-token: ${{ github.token }}
|
||||||
issue-inactive-days: '7'
|
issue-inactive-days: '7'
|
||||||
issue-comment: >
|
issue-comment: >
|
||||||
This thread has been automatically locked since there has not been
|
This thread has been automatically locked since there has not been
|
||||||
|
|||||||
@@ -0,0 +1,23 @@
|
|||||||
|
name: Main
|
||||||
|
on:
|
||||||
|
workflow_dispatch:
|
||||||
|
push:
|
||||||
|
branches:
|
||||||
|
- main
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
build:
|
||||||
|
if: "! startsWith(github.event.head_commit.message, '[CI Skip]')"
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v4
|
||||||
|
with:
|
||||||
|
fetch-depth: 0
|
||||||
|
- uses: actions/setup-node@v4
|
||||||
|
with:
|
||||||
|
node-version: 'lts/*'
|
||||||
|
- name: Build
|
||||||
|
run: |
|
||||||
|
corepack enable
|
||||||
|
yarn install --immutable
|
||||||
|
yarn build
|
||||||
@@ -1,31 +0,0 @@
|
|||||||
name: Master
|
|
||||||
on:
|
|
||||||
push:
|
|
||||||
branches:
|
|
||||||
- master
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
master:
|
|
||||||
if: "! startsWith(github.event.head_commit.message, '[CI Skip]')"
|
|
||||||
strategy:
|
|
||||||
matrix:
|
|
||||||
step: ['build:release']
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
env:
|
|
||||||
YARN_ENABLE_SCRIPTS: false
|
|
||||||
CC_TEST_REPORTER_ID: ${{ secrets.CC_TEST_REPORTER_ID }}
|
|
||||||
GH_PAT: ${{ secrets.GH_PAT_BOT }}
|
|
||||||
GH_RELEASE_GITHUB_API_TOKEN: ${{ secrets.GH_PAT_BOT }}
|
|
||||||
NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
|
|
||||||
steps:
|
|
||||||
- uses: actions/checkout@v4
|
|
||||||
with:
|
|
||||||
fetch-depth: 0
|
|
||||||
token: ${{ secrets.GH_PAT_BOT }}
|
|
||||||
- uses: actions/setup-node@v4
|
|
||||||
with:
|
|
||||||
node-version: 'lts/*'
|
|
||||||
- name: ${{ matrix.step }}
|
|
||||||
run: |
|
|
||||||
yarn install --immutable
|
|
||||||
yarn ${{ matrix.step }}
|
|
||||||
@@ -1,18 +1,80 @@
|
|||||||
# @pezkuwi/ui
|
# @pezkuwi/ui
|
||||||
|
|
||||||
Basic browser and framework agnostic UI components for creating apps using the polkadot{.js} libraries
|
Basic browser and framework agnostic UI components for creating apps using the PezkuwiChain libraries.
|
||||||
|
|
||||||
## overview
|
**Developed by Dijital Kurdistan Tech Institute**
|
||||||
|
|
||||||
The following UI components are currently available -
|
## Overview
|
||||||
|
|
||||||
- [react-identicon](packages/react-identicon/) React identity icon generator with address as input
|
This package provides UI components for building applications on PezkuwiChain.
|
||||||
- [reactnative-identicon](packages/reactnative-identicon/) React Native identity icon generator with address as input
|
|
||||||
- [vue-identicon](packages/vue-identicon/) Vue identity icon generator with address as input
|
|
||||||
- [react-qr](packages/react-qr/) QR code generator/reader for [uos](https://github.com/maciejhirsz/uos) (Substrate/Polkadot only)
|
|
||||||
|
|
||||||
Additionally some shared libraries, that are not dependent on any framework -
|
## Packages
|
||||||
|
|
||||||
- [ui-keyring](packages/ui-keyring/) A browser-specific wrapper around the base [@pezkuwi/keyring](https://github.com/pezkuwichain/common/) library
|
### UI Components
|
||||||
- [ui-settings](packages/ui-settings/) A browser local storage wrapper for app settings & configuration
|
|
||||||
- [ui-shared](packages/ui-shared) Shared logic that is used across UI components, e.g. for icon generation
|
- [react-identicon](packages/react-identicon/) - React identity icon generator with address as input
|
||||||
|
- [reactnative-identicon](packages/reactnative-identicon/) - React Native identity icon generator with address as input
|
||||||
|
- [vue-identicon](packages/vue-identicon/) - Vue identity icon generator with address as input
|
||||||
|
- [react-qr](packages/react-qr/) - QR code generator/reader for PezkuwiChain
|
||||||
|
|
||||||
|
### Shared Libraries
|
||||||
|
|
||||||
|
- [ui-keyring](packages/ui-keyring/) - A browser-specific wrapper around [@pezkuwi/keyring](https://github.com/pezkuwichain/pezkuwi-common/)
|
||||||
|
- [ui-settings](packages/ui-settings/) - A browser local storage wrapper for app settings
|
||||||
|
- [ui-shared](packages/ui-shared/) - Shared logic used across UI components (e.g., icon generation)
|
||||||
|
|
||||||
|
## Installation
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# Using npm
|
||||||
|
npm install @pezkuwi/react-identicon
|
||||||
|
|
||||||
|
# Using yarn
|
||||||
|
yarn add @pezkuwi/react-identicon
|
||||||
|
```
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
|
||||||
|
```javascript
|
||||||
|
import Identicon from '@pezkuwi/react-identicon';
|
||||||
|
|
||||||
|
function App() {
|
||||||
|
return (
|
||||||
|
<Identicon
|
||||||
|
value="5GrwvaEF5zXb26Fz9rcQpDWS57CtERHpNehXCPcNoHGKutQY"
|
||||||
|
size={64}
|
||||||
|
theme="polkadot"
|
||||||
|
/>
|
||||||
|
);
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
## Development
|
||||||
|
|
||||||
|
### Prerequisites
|
||||||
|
|
||||||
|
- Node.js >= 18.14
|
||||||
|
- Yarn 4.x (via corepack)
|
||||||
|
|
||||||
|
### Building
|
||||||
|
|
||||||
|
```bash
|
||||||
|
corepack enable
|
||||||
|
yarn install
|
||||||
|
yarn build
|
||||||
|
```
|
||||||
|
|
||||||
|
## Links
|
||||||
|
|
||||||
|
- Website: https://pezkuwichain.io
|
||||||
|
- Documentation: https://docs.pezkuwichain.io
|
||||||
|
- GitHub: https://github.com/pezkuwichain
|
||||||
|
- API Docs: https://js.pezkuwichain.app
|
||||||
|
|
||||||
|
## License
|
||||||
|
|
||||||
|
Apache-2.0
|
||||||
|
|
||||||
|
## Author
|
||||||
|
|
||||||
|
Dijital Kurdistan Tech Institute
|
||||||
|
|||||||
Reference in New Issue
Block a user