🗒️ Update README

KimlikDAO · Feb 2, 2025 · 9376137 · 9376137
1 parent 3b4a6a3
commit 9376137
Show file tree

Hide file tree

Showing 8 changed files with 53 additions and 48 deletions.
diff --git a/README.md b/README.md
@@ -1,43 +1,46 @@
 <h1><img src="components/icon.svg" align="top" height="44"> KimlikDAO dApp</a></h1>
 
-## Dizinler
 
-Her http request gerektiren bölümü 'sayfa' olarak adlandırıyoruz.
-Her sayfa için gerekli dosyalar http `pathname`'i ile aynı isimli
-bir dizinde toplanıyor.
+# 👋 Introduction
 
-Buna istisna `/` pathindeki ana sayfa; bu sayfaya `ana` dizinini
-ayırıyoruz.
+Using the KimlikDAO dApp, you can mint your KPass by interacting with the
+KimlikDAO network and inscribe it on one of the blockchains we support
+(such as Ethereum, Arbitrum, Mina, etc).
 
-Sayfaların bazı `altbirim`leri olabilir; bunlar sayfa içindeki sınırları belli
-bileşenler ve bu bileşenlere ait her dosya altbirimle aynı adda bir dizinde
-duruyor. Örneğin `al/` sayfasının `tanışma` ve `ödeme` gibi altbirimleri
-`al/tanışma` ve `al/ödeme` dizininde duruyor.
+The KimlikDAO dApp is truly decentralized: you can run it locally, deploy it
+on your own server, or use the reference deployment at [kimlikdao.org](https://kimlikdao.org).
 
-Birden çok yerde kullanılabilen bileşenlere ise `birim` adını
-veriyoruz ve bunları `birim/` dizinine koyuyoruz.
+The dApp will connect to the KimlikDAO network nodes and the node discovery will be initiated
+through the seeed nodes at `node.kimlikdao.org`, `kdao-node.yenibank.org`, `kdao-node.blinkbridge.xyz`.
+To modify the seed nodes, edit the list in `lib/node/network.js`.
 
-## Kullanım
+For blockchain nodes, the dApp has no hardcoded rpc urls and will rely on your wallet's provider.
 
-Yazılımcıların dApp'i test etmesi için gereken adımlar:
+## 🧑‍💻 Developer Guide
 
-- `git clone --recursive https://github.com/KimlikDAO/dapp`
+The KimlikDAO dApp is built with our in-house framework, [kastro](https://github.com/KimlikDAO/kimlikdao-js/tree/ana/kastro). Kastro provides a familiar react-like experience yet allows us to build
+highly optimized and lightweight fontends by pushing as much work as possible to the compile time.
 
-- `bun i` gerekli build araçlarını ve dev sunucusunu yükler
+To run the dApp, follow these steps:
 
-- `bun run dev` dev sunucuyu çalıştırır.
-  - http://localhost:8787/
+- `git clone --recursive https://github.com/KimlikDAO/dapp`
 
-dApp 3 farklı şekilde çalıştırılabilir:
+- `bun i` install the required npm packages
 
- - `bun run dev` en az işi yaparak en hızlı şekilde dApp'i yükler
- - `bun run compiled` istenen sayfa ve assetleri derleyip yollar
- - `bun run canary` deploy için hazırlanmış `crate`'i sunar
+- `bun dev` run the dev server
+  - http://localhost:8787/
 
-Deploy için gerekli crate `bun run build` ile oluşturulur. `canary` ve `build` için npm paketlerine ek
-olarak şu araçlar gerekli:
+The dApp can also be run in `compiled` and `canary` modes.
+To run the dApp in these modes, we need other tools installed:
 
 ```shell
+# brew dependencies
 brew install pngcrush brotli zopfli woff2 webp librsvg
+# pip dependencies
 pip install fonttools
 ```
+
+With these dependencies installed, we can run the dApp in `compiled` and `canary` modes:
+
+- `bun compiled` compile the required pages and assets
+- `bun canary` serve the `bundle` prepared for deployment
diff --git a/components/chains/chains.js b/components/chains/chains.js
@@ -20,44 +20,44 @@ const ChainInfos = {
   [ChainId.x1]: {
     uiName: "Ethereum",
     explorer: "etherscan.io",
-    tokenKodu: "ETH",
+    tokenCode: "ETH",
     token: "ether",
     tokenSuffix: dom.i18n({ tr: ["’den", "’e"], en: [] }),
     rpcUrl: "cloudflare-eth.com",
   },
   [ChainId.xa86a]: {
     uiName: "Avalanche",
     explorer: "snowtrace.io",
-    tokenKodu: "AVAX",
+    tokenCode: "AVAX",
     tokenSuffix: dom.i18n({ tr: ["’tan", "’a"], en: [] }),
     rpcUrl: "api.avax.network/ext/bc/C/rpc",
   },
   [ChainId.x89]: {
     uiName: "Polygon",
     explorer: "polygonscan.com",
-    tokenKodu: "MATIC",
+    tokenCode: "MATIC",
     tokenSuffix: dom.i18n({ tr: ["’ten", "’e"], en: [] }),
     rpcUrl: "polygon-rpc.com"
   },
   [ChainId.xa4b1]: {
     uiName: "Arbitrum One",
     explorer: "arbiscan.io",
-    tokenKodu: "ETH",
+    tokenCode: "ETH",
     token: "ether",
     tokenSuffix: dom.i18n({ tr: ["’den", "’e"], en: [] }),
     rpcUrl: "arb1.arbitrum.io/rpc",
   },
   [ChainId.x38]: {
     uiName: "BNB Chain",
     explorer: "bscscan.com",
-    tokenKodu: "BNB",
+    tokenCode: "BNB",
     tokenSuffix: dom.i18n({ tr: ["’den", "’ye"], en: [] }),
     rpcUrl: "bsc-dataseed3.binance.org"
   },
   [ChainId.MinaMainnet]: {
     uiName: "Mina",
     explorer: "minaexplorer:.com",
-    tokenKodu: "MINA",
+    tokenCode: "MINA",
     tokenSuffix: dom.i18n({ tr: ["’dan", "’ya"], en: [] }),
     rpcUrl: "api.minaexplorer:.com"
   },

diff --git a/landing/Learn2Earn.jsx b/landing/Learn2Earn.jsx
@@ -30,7 +30,7 @@ const Learn2Earn = () => (
           topla. Çok yakında!</>
       }}</span>
       <br />
-      <a href={ExternalPage.Blog} class={[SharedCss.Düğme, SharedCss.Bilgi, LandingCss.ÜstBoşluk]}>{{
+      <a href={ExternalPage.Blog} class={[SharedCss.Düğme, SharedCss.Bilgi, LandingCss.TopSpaced]}>{{
         en: "Learn & earn (Soon!)",
         tr: "Öğren ve kazan (Yakında!)"
       }}</a>

diff --git a/landing/Reports.jsx b/landing/Reports.jsx
@@ -3,7 +3,7 @@ import Feb25 from "/components/blog/2025.02/birim";
 import SharedCss from "/components/ortakcss/birim.css";
 
 const Reports = () => (
-  <div class={LandingCss.Üçlü}>
+  <div class={LandingCss.ThreeColumn}>
     <div></div>
     <Feb25 href={""} loading="lazy" />
     <div class={LandingCss.SağaYaslı}>
@@ -21,7 +21,7 @@ const Reports = () => (
           katıldığımız etkinliklerden, kurduğumuz yeni ortaklıklara tüm
           gelişmelerini aylık ilerleme raporlarından okuyun.</>
       }}</span><br />
-      <a href="//blog.kimlikdao.org" class={[SharedCss.Düğme, SharedCss.Mavi, LandingCss.ÜstBoşluk]}>{{
+      <a href="//blog.kimlikdao.org" class={[SharedCss.Düğme, SharedCss.Mavi, LandingCss.TopSpaced]}>{{
         en: "All progress reports",
         tr: "Tüm ilerleme raporları"
       }}</a>

diff --git a/landing/network/Network.css b/landing/network/Network.css
@@ -22,11 +22,11 @@
 
 #Altıgen {}
 
-.Düğümİmza:hover {
+.NodeSignature:hover {
   opacity: 1;
 }
 
-.Düğümİmza {
+.NodeSignature {
   align-items: center;
   border-radius: 15px;
   color: rgba(10, 10, 100, 0.9);
@@ -40,7 +40,7 @@
   width: 180px;
 }
 
-.DüğümNokta {
+.NodePoint {
   width: 10px;
   height: 10px;
   border-radius: 10px;

diff --git a/landing/network/Network.jsx b/landing/network/Network.jsx
@@ -14,8 +14,8 @@ import { keccak256 } from "/lib/crypto/sha3";
 const Node = ({ idx }) => {
   const shortAddress = (addr) => `0x${addr.slice(0, 8)}...${addr.slice(8, 16)}`;
   return (
-    <div class={[Css.Düğümİmza, Css[idx]]}>
-      <div class={[Css.DüğümNokta, Css[`${idx}n`]]}></div>{shortAddress(keccak256(idx))}
+    <div class={[Css.NodeSignature, Css[idx]]}>
+      <div class={[Css.NodePoint, Css[`${idx}n`]]}></div>{shortAddress(keccak256(idx))}
     </div>
   );
 }
@@ -65,7 +65,8 @@ const Graph = ({ width }) => {
         const x = Math.round(cx + r * Math.sin((Math.PI * 2 * i) / n));
         const y = Math.round(cy - r * Math.cos((Math.PI * 2 * i) / n));
         return (<>
-          <use href={`#${Css.Altıgen}`} x={x - 45} y={y - 75} fill={h(NODES[key][2])} stroke={h(NODES[key][3])} />
+          <use href={`#${Css.Altıgen}`} x={x - 45} y={y - 75}
+            fill={h(NODES[key][2])} stroke={h(NODES[key][3])} />
           <text x={x} y={y - 30} text-anchor="middle" fill="#fff">{NODES[key][0].slice(0, 8)}</text>
           <text x={x} y={y + 23} text-anchor="middle" fill="#444">{NODES[key][1]}</text>
         </>);
@@ -75,7 +76,7 @@ const Graph = ({ width }) => {
 }
 
 const Network = () => (
-  <div id={Css.Network} class={LandingCss.Üçlü}>
+  <div id={Css.Network} class={LandingCss.ThreeColumn}>
     <Css />
     <div id={Css.TextColumn}>
       <h2 class={SharedCss.Mavi}>{{
@@ -86,10 +87,11 @@ const Network = () => (
         en: "The contents of each KPass are verified and digitally signed by at least seven independent nodes in the KimlikDAO network, all while fully preserving your privacy.",
         tr: "KPass’ler birbirinden bağımsız en az 7 KimlikDAO ağı düğümünün onay ve dijital imzası ile üretilebilir. Onay aşamasında veri gizliliğiniz tamamıyla korunur."
       }}</div>
-      <a href={ExternalPage.GitHub + "/kimlikdao-node"} target="_blank" rel="noreferrer" class={[SharedCss.Düğme, SharedCss.Bilgi, LandingCss.ÜstBoşluk]}>{{
-        en: "Learn about KimlikDAO nodes",
-        tr: "KimlikDAO düğümü detayları"
-      }}</a>
+      <a href={ExternalPage.GitHub + "/kimlikdao-node"} target="_blank" rel="noreferrer"
+        class={[SharedCss.Düğme, SharedCss.Bilgi, LandingCss.TopSpaced]}>{{
+          en: "Learn about KimlikDAO nodes",
+          tr: "KimlikDAO düğümü detayları"
+        }}</a>
     </div>
     <div id={Css.MiddleColumn}>
       <KPassDemo />

diff --git a/landing/page.css b/landing/page.css
@@ -9,7 +9,7 @@
 /**
  * Üç sütunlu alt hero
  */
-.Üçlü {
+.ThreeColumn {
   display: grid;
   gap: 20px;
   grid-template-columns: repeat(auto-fit, minmax(300px, 1fr));
@@ -29,7 +29,7 @@
   margin: 100px 0;
 }
 
-.ÜstBoşluk {
+.TopSpaced {
   margin-top: 30px;
 }
 

diff --git a/landing/page.jsx b/landing/page.jsx
@@ -28,8 +28,8 @@ const Chains = [
 
 /** @const {!Object<ChainId, I18nString>} */
 const ChainNotes = {
-  [ChainId.xa4b1]: { tr: "Ana ağ", en: "Signal chain" },
-  [ChainId.MinaMainnet]: { tr: "Yeni ✨", en: "New ✨" },
+  [ChainId.xa4b1]: { en: "Signal chain", tr: "Ana ağ" },
+  [ChainId.MinaMainnet]: { en: "New ✨", tr: "Yeni ✨" },
 };
 
 /** @const {ChainId} */