From ca92e684999e40b937583470ab3364f635502478 Mon Sep 17 00:00:00 2001 From: neila <40727091+neila@users.noreply.github.com> Date: Sat, 10 Feb 2024 17:11:14 +0900 Subject: [PATCH] update readme --- README.md | 44 ++++++++++++++++---------------------------- 1 file changed, 16 insertions(+), 28 deletions(-) diff --git a/README.md b/README.md index 2cd4faf..2a00b14 100644 --- a/README.md +++ b/README.md @@ -1,44 +1,32 @@ -## ✅Astar-SocialFi(prototype) +# ✅Astar-SocialFi (prototype) -本レポジトリは Astar-SocialFi の完成版を示したものになります。 +[Repository](https://github.com/unchain-tech/ASTAR-SocialFi) -以下の手順を実行することで Astar-SocialFi の挙動を確認できます。 +## Instructions -## レポジトリのクローン +1. Install packages -[Astar-SocialFi のリポジトリ](https://github.com/unchain-tech/ASTAR-SocialFi)から Astar-SocialFi をクローンします。 +``` +yarn install +``` -### コントラクトとフロントの準備 -1. コントラクトのデプロイ +2. Contract deployment -[Astar-SocialFi の教材](https://app.unchain.tech/learn/ASTAR-SocialFi/ja/0/2/)のうち section0-Lesson2 の polkadot.js の説明箇所を参考にコントラクトのデプロイを行います。 +[Astar-SocialFi の教材](https://github.com/unchain-tech/UNCHAIN-Projects/tree/main/docs/ASTAR-SocialFi/ja/) の section0-Lesson2 の `polkadot.js` の説明箇所を参考にコントラクトのデプロイを行います。 -デプロイ後はコントラクトアドレスをどこかへ控えておいてください。 +デプロイ時はコントラクトのアドレスを控えておいてください。 -2. ウォレットの作成 +3. Create wallet +section1-Lesson4 の `polkadot.js` という拡張機能を追加してウォレットを作成する部分を参考にしてウォレットを作成しましょう。 -[Astar-SocialFi の教材](https://app.unchain.tech/learn/ASTAR-SocialFi/ja/1/1/)のうち section1-Lesson4 の polkadot.js という拡張機能を追加してウォレットを作成する部分を参考にしてウォレットを作成しましょう。 +その後、作成したアドレスへ Alice から 10 トークン程度送金しましょう。ガス代として使用します。 -作成したら、Alice という元々あるアカウントから 10 トークンほど作成したアドレスへ送金しておきましょう。ガス代として使用します。 -3. フロントエンドのパッケージをインストール +4. Setup frontend -トップディレクトリで下のコマンドを実行することで必要なパッケージをインストールしましょう。 +section3-Lesson1 での動作確認の工程を参考にフロントの様子を確認しましょう。 ``` -yarn install +yarn client dev ``` - -4. .env ファイルの作成、記述 - -1.で得たコントラクトアドレスと、ユーザーの初期プロフィール画像を下の変数名で設定しましょう。画像 URL は[unsplash のサイト](https://unsplash.com/)から取得しましょう。 - -``` -NEXT_PUBLIC_CONTRACT_ADDRESS=WCpkcJenKkFZwk2tot1yhyvZuwFXD2xdzb7dyn2WMebKtC6 -NEXT_PUBLIC_UNKNOWN_IMAGE_URL="https://images.unsplash.com/..." -``` - -5. フロントエンドの立ち上げ - -最後に下のコマンドを実行することでフロントエンドを立ち上げます。その後は[Astar-SocialFi の教材](https://app.unchain.tech/learn/ASTAR-SocialFi/ja/3/1/)のうち section3-Lesson1 での動作確認の工程を参考にフロントの様子を確認しましょう。