Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 21 additions & 11 deletions apps/interface/README.md
Original file line number Diff line number Diff line change
@@ -1,37 +1,47 @@
# iCKB interface
# iCKB Interface

## Run the web interface locally
iCKB interface built on top of CCC and the workspace `@ickb/*` packages.

1. Download this repo in a folder of your choice:
## Run locally

1. Clone the monorepo:

```bash
git clone https://github.com/ickb/stack.git
```

2. Enter into the repo folder:
2. Enter the repo root:

```bash
cd stack/apps/interface
cd stack
```

3. Install dependencies:
3. Install dependencies and materialize the local CCC workspace:

```bash
pnpm forks:bootstrap
pnpm install
pnpm forks:ccc
```

4. Build project:
4. Start the interface dev server from the repo root:

```bash
pnpm build
pnpm --filter ./apps/interface dev
```

5. Preview the interface:
That script builds the workspace `@ickb/*` package `dist/` outputs first because the interface resolves those packages to their built CCC-compatible entrypoints during local development.

5. Build the interface when you want a production bundle:

```bash
pnpm run preview;
pnpm --filter ./apps/interface build
```

Like `dev`, the build script refreshes those workspace package `dist/` outputs first so a clean checkout does not rely on stale generated files.

The interface now uses CCC-native wallet connection and transaction completion. Protocol-specific transaction construction comes from `@ickb/sdk`, then the app completes iCKB UDT balance, CKB capacity, and fees before sending.

## Licensing

This source code, crafted with care by [Phroi](https://phroi.com/), is freely available on [GitHub](https://github.com/ickb/stack.git) and it is released under the [MIT License](../../LICENSE).
This source code, crafted with care by [Phroi](https://phroi.com/), is freely available on [GitHub](https://github.com/ickb/stack) and it is released under the [MIT License](../../LICENSE).
39 changes: 22 additions & 17 deletions apps/interface/package.json
Original file line number Diff line number Diff line change
@@ -1,19 +1,29 @@
{
"name": "interface",
"version": "1.4.3",
"description": "iCKB Web DApp",
"name": "@ickb/interface",
"version": "1001.0.0",
"description": "iCKB interface built on top of CCC",
"keywords": [
"ickb",
"ccc",
"ckb",
"blockchain"
],
"author": "phroi",
"license": "MIT",
"private": false,
"homepage": "https://github.com/ickb/interface",
"homepage": "https://ickb.org",
"repository": {
"type": "git",
"url": "git://github.com/ickb/interface.git"
"url": "https://github.com/ickb/stack"
},
"bugs": {
"url": "https://github.com/ickb/stack/issues"
},
"sideEffects": false,
"type": "module",
"private": false,
"scripts": {
"dev": "vite",
"build": "tsc && vite build",
"dev": "pnpm --filter @ickb/core --filter @ickb/order --filter @ickb/sdk --filter @ickb/utils build && vite",
"build": "pnpm --filter @ickb/core --filter @ickb/order --filter @ickb/sdk --filter @ickb/utils build && tsc && vite build",
"preview": "vite preview",
"lint": "eslint ./src",
"clean": "rm -fr dist",
Expand All @@ -34,16 +44,11 @@
},
"dependencies": {
"@ckb-ccc/ccc": "catalog:",
"@ckb-lumos/base": "^0.23.0",
"@ckb-lumos/codec": "^0.23.0",
"@ckb-lumos/common-scripts": "^0.23.0",
"@ckb-lumos/config-manager": "^0.23.0",
"@ckb-lumos/helpers": "^0.23.0",
"@ckb-lumos/rpc": "^0.23.0",
"@ickb/lumos-utils": "1.4.2",
"@ickb/v1-core": "1.4.2",
"@ickb/core": "workspace:*",
"@ickb/order": "workspace:*",
"@ickb/sdk": "workspace:*",
"@ickb/utils": "workspace:*",
"@tanstack/react-query": "^5.90.5",
"immutable": "^4.3.7",
"react": "^19.2.0",
"react-dom": "^19.2.0"
}
Expand Down
Loading
Loading