Files
pwap/README.md
T
SatoshiQaziMuhammed b778493eaa docs(readme): point related repositories at pezkuwi-apps and pezkuwi-explorer (#58)
pezkuwi-sdk-ui was deleted; its developer tools ship from pezkuwi-apps
(js.pezkuwichain.io) and the explorer lives in pezkuwi-explorer.
2026-10-19 13:05:46 +04:00

162 lines
3.5 KiB
Markdown

# Pezkuwi Web App Projects (PWAP)
Monorepo for Pezkuwi blockchain frontend applications.
## Project Structure
```
pwap/
├── web/ # Main web application
├── sign/ # Multisig signing portal
├── backend/ # Indexer service
├── shared/ # Shared code and utilities
├── ops/ # CI deploy gate checks and host deploy scripts
└── package.json # Root package with build scripts
```
## Related Repositories
| Repository | Description | URL |
|------------|-------------|-----|
| pezkuwi-apps | Developer Tools ([js.pezkuwichain.io](https://js.pezkuwichain.io)) | https://github.com/pezkuwichain/pezkuwi-apps |
| pezkuwi-explorer | Blockchain Explorer ([explorer.pezkuwichain.io](https://explorer.pezkuwichain.io)) | https://github.com/pezkuwichain/pezkuwi-explorer |
| pezkuwi-extension | Browser Wallet Extension | https://github.com/pezkuwichain/pezkuwi-extension |
## Projects
### 1. `web/` - Main Web Application
**Status:** ✅ Production Ready
The primary web interface for Pezkuwi blockchain at [app.pezkuwichain.io](https://app.pezkuwichain.io)
**Tech Stack:**
- React 18 + TypeScript
- Vite
- @pezkuwi/api
- Supabase (Auth & Database)
- Tailwind CSS + shadcn/ui
- i18next
**Features:**
- Wallet integration (Pezkuwi Extension)
- Live blockchain data
- Staking dashboard
- DEX/Swap interface
- P2P Fiat Trading with atomic escrow
- Transaction history
- Multi-language support (EN, TR, KMR, CKB, AR, FA)
- Governance with live blockchain integration
```bash
cd web
npm install
npm run dev
```
### 2. `sign/` - Multisig Signing Portal
A deliberately small app with one job: approve and sign pending multisig
operations. It compiles `shared/lib` and is typechecked and built in CI.
```bash
cd sign
npm install
npm run build
```
### 3. `backend/` - Indexer Service
API services for the applications.
```bash
cd backend
npm install
npm run dev
```
### 4. `shared/` - Shared Code
Common code, types, and utilities used across all platforms.
```
shared/
├── types/ # TypeScript type definitions
├── utils/ # Helper functions
├── blockchain/ # Blockchain utilities
├── constants/ # App constants
├── images/ # Shared images and logos
└── i18n/ # Internationalization
```
## Quick Start
### Prerequisites
- Node.js 24
- npm
### Installation
```bash
# Clone repository
git clone https://github.com/pezkuwichain/pwap.git
cd pwap
# Install all dependencies
npm install
# Or install individually
npm run install:web
npm run install:sign
npm run install:backend
```
### Build All Projects
```bash
npm run build
```
This builds:
1. `web` - Vite production build
2. `sign` - typecheck and Vite production build
### Development
```bash
npm run dev:web
```
## Multi-Language Support
All applications support:
- 🇬🇧 English (EN)
- 🇹🇷 Türkçe (TR)
- ☀️ Kurmancî (KMR)
- ☀️ سۆرانی (CKB)
- 🇸🇦 العربية (AR)
- 🇮🇷 فارسی (FA)
RTL support for CKB, AR, FA.
## Scripts
| Command | Description |
|---------|-------------|
| `npm run build` | Build all projects |
| `npm run dev` | Start development servers |
| `npm run lint` | Run linters |
| `npm run test` | Run tests |
| `npm run install:all` | Install all dependencies |
## Links
- **Website:** https://app.pezkuwichain.io
- **Website (alt):** https://pex.mom
- **Exchange:** https://pex.network
- **Documentation:** https://docs.pezkuwichain.io
## License
Apache-2.0