From b60b91b82f64f2a9eafdfcef94804bf989d99e18 Mon Sep 17 00:00:00 2001 From: Alberto Granzotto Date: Fri, 8 Nov 2024 22:00:08 +0100 Subject: [PATCH] update readme --- README.md | 38 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 38 insertions(+) diff --git a/README.md b/README.md index b06d512..a36210a 100644 --- a/README.md +++ b/README.md @@ -3,3 +3,41 @@ CBD stands for Cloud Based Demo. Check out [THC](https://github.com/social-dist0rtion-protocol/thc). + +## GitHub Actions Setup for THC (Treasure Hunt Code) Deployment + +This project requires specific GitHub secrets for deploying the Treasure Hunt Code (THC) application using GitHub Actions. The following secrets should be set up in your GitHub repository. + +### Required Secrets + +Add these secrets in your GitHub repository settings under **Settings > Secrets and variables > Actions > New repository secret**. + +#### 1. `ETHEREUM_ENDPOINT` + +- **Description**: Ethereum node endpoint URL for interacting with the Ethereum blockchain. +- **Example**: `https://mainnet.infura.io/v3/YOUR_INFURA_PROJECT_ID` + +#### 2. `PRIVATE_KEY` + +- **Description**: Private key for signing transactions. Make sure to store this securely. +- **Format**: A hexadecimal private key string, without the `0x` prefix. + +#### 3. `VITE_RPC_NODE_URL` + +- **Description**: Node URL used in the web build environment for connecting to the blockchain. +- **Example**: `https://mainnet.infura.io/v3/YOUR_INFURA_PROJECT_ID` + +#### 4. `VITE_WALLET_CONNECT_PROJECT_ID` + +- **Description**: Project ID for WalletConnect integration. +- **Example**: `YOUR_WALLET_CONNECT_PROJECT_ID` + +#### 5. `DEPLOYER_SSH_KEY` + +- **Description**: SSH private key for deploying the build to the target repository. +- **Format**: The private key content as a single line. + +#### 6. `TARGET_REPO` + +- **Description**: GitHub repository path (e.g., `username/repo-name`) where the built files will be deployed. +- **Example**: `my-username/target-repo`