From 35be62b28e0240525f14933a631ae5bc2cbf5b6a Mon Sep 17 00:00:00 2001 From: Thomas E Lackey Date: Fri, 23 Feb 2024 15:57:34 -0600 Subject: [PATCH] readme formatting (#105) Co-authored-by: Vivian Phung --- README.md | 82 ++++++++++++++++++++++++++++++++++--------------------- 1 file changed, 51 insertions(+), 31 deletions(-) diff --git a/README.md b/README.md index 8e746eb9..b6292209 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,8 @@ -# snowballtools +# snowballtools-base ## Setup -- Clone the `snowballtools` repo +- Clone the `snowballtools-base` repo ```bash git clone git@github.com:snowball-tools/snowballtools-base.git @@ -29,19 +29,19 @@ ``` - Set `gitHub.oAuth.clientId` and `gitHub.oAuth.clientSecret` in backend [config file](packages/backend/environments/local.toml) - - Client ID and secret will be available after creating Github OAuth app - - https://docs.github.com/en/apps/oauth-apps/building-oauth-apps/creating-an-oauth-app + - Client ID and secret will be available after [creating an OAuth app](https://docs.github.com/en/apps/oauth-apps/building-oauth-apps/creating-an-oauth-app) - In "Homepage URL", type `http://localhost:3000` - In "Authorization callback URL", type `http://localhost:3000/organization/projects/create` - Generate a new client secret after app is created -### Production +### Backend Production - Let us assume the following domains for backend and frontend - - Backend server: `api.snowball.com` - - Frontend app: `dashboard.snowball.com` + - Backend server: `api.snowballtools.com` + - Frontend app: `dashboard.snowballtools.com` - Update the following in backend [config file](packages/backend/environments/local.toml) + ```toml [server] ... @@ -49,7 +49,7 @@ # Secret should be changed to a different random string secret = "p4yfpkqnddkui2iw7t6hbhwq74lbqs7sidnc382" # Set URL of the frontend app - appOriginUrl = "https://dashboard.snowball.com" + appOriginUrl = "https://dashboard.snowballtools.com" # Set to true for session cookies to work behind proxy trustProxy = true # Set empty domain when using secure connection @@ -57,21 +57,22 @@ ``` - Set `gitHub.oAuth.clientId` and `gitHub.oAuth.clientSecret` in backend [config file](packages/backend/environments/local.toml) - - Client ID and secret will be available after creating Github OAuth app - - https://docs.github.com/en/apps/oauth-apps/building-oauth-apps/creating-an-oauth-app - - In "Homepage URL", type `https://dashboard.snowball.com` - - In "Authorization callback URL", type `https://dashboard.snowball.com/organization/projects/create` + - Client ID and secret will be available after [creating an OAuth app](https://docs.github.com/en/apps/oauth-apps/building-oauth-apps/creating-an-oauth-app) + - In "Homepage URL", type `https://dashboard.snowballtools.com` + - In "Authorization callback URL", type `https://dashboard.snowballtools.com/organization/projects/create` - Generate a new client secret after app is created - Set `gitHub.webhookUrl` in backend [config file](packages/backend/environments/local.toml) + ```toml ... [gitHub] - webhookUrl = "https://api.snowball.com" + webhookUrl = "https://api.snowballtools.com" ... ``` - Let us assume domain for Laconicd to be `api.laconic.com` and set the following in backend [config file](packages/backend/environments/local.toml) + ```toml ... [registryConfig] @@ -100,11 +101,10 @@ yarn start ``` -### Development +### Backend Development - Set `gitHub.oAuth.clientId` and `gitHub.oAuth.clientSecret` in backend [config file](packages/backend/environments/local.toml) - - Client ID and secret will be available after creating Github OAuth app - - https://docs.github.com/en/apps/oauth-apps/building-oauth-apps/creating-an-oauth-app + - Client ID and secret will be available after [creating an OAuth app](https://docs.github.com/en/apps/oauth-apps/building-oauth-apps/creating-an-oauth-app) - In "Homepage URL", type `http://localhost:3000` - In "Authorization callback URL", type `http://localhost:3000/organization/projects/create` - Generate a new client secret after app is created @@ -112,12 +112,15 @@ - Setup Laconicd - Run the laconicd stack following this [doc](https://git.vdb.to/cerc-io/stack-orchestrator/src/branch/main/docs/laconicd-with-console.md) - Get the private key and set `registryConfig.privateKey` in backend [config file](packages/backend/environments/local.toml) + ```bash laconic-so --stack fixturenet-laconic-loaded deploy exec laconicd "laconicd keys export mykey --unarmored-hex --unsafe" # WARNING: The private key will be exported as an unarmored hexadecimal string. USE AT YOUR OWN RISK. Continue? [y/N]: y # 754cca7b4b729a99d156913aea95366411d072856666e95ba09ef6c664357d81 ``` + - Get the REST and GQL endpoint ports of Laconicd and replace the ports for `registryConfig.restEndpoint` and `registryConfig.gqlEndpoint` in backend [config file](packages/backend/environments/local.toml) + ```bash # For registryConfig.restEndpoint laconic-so --stack fixturenet-laconic-loaded deploy port laconicd 1317 @@ -127,28 +130,36 @@ laconic-so --stack fixturenet-laconic-loaded deploy port laconicd 9473 # 0.0.0.0:32771 ``` + - Set authority in `registryConfig.authority` in backend [config file](packages/backend/environments/local.toml) - Run the script to create bond, reserve the authority and set authority bond + ```bash yarn test:registry:init # snowball:initialize-registry bondId: 6af0ab81973b93d3511ae79841756fb5da3fd2f70ea1279e81fae7c9b19af6c4 +0ms ``` + - Get the bond id and set `registryConfig.bondId` in backend [config file](packages/backend/environments/local.toml) - Setup ngrok for GitHub webhooks - - https://ngrok.com/docs/getting-started/ + - [ngrok getting started](https://ngrok.com/docs/getting-started/) - Start ngrok and point to backend server endpoint + ```bash ngrok http http://localhost:8000 ``` + - Look for the forwarding URL in ngrok - ``` + + ```bash ... Forwarding https://19c1-61-95-158-116.ngrok-free.app -> http://localhost:8000 ... ``` + - Set `gitHub.webhookUrl` in backend [config file](packages/backend/environments/local.toml) + ```toml ... [gitHub] @@ -165,55 +176,63 @@ ## Frontend - Change directory to `packages/frontend` in a new terminal + ```bash cd packages/frontend ``` - Copy the GitHub OAuth app client ID from previous steps and set it in frontend [.env](packages/frontend/.env) file + ```env REACT_APP_GITHUB_CLIENT_ID = ``` - Set `REACT_APP_GITHUB_TEMPLATE_REPO` in [.env](packages/frontend/.env) file + ```env # Set actual owner/name of the template repo that will be used for creating new repo REACT_APP_GITHUB_TEMPLATE_REPO = cerc-io/test-progressive-web-app ``` -### Production +### Frontend Production - Let us assume the following domains for backend and frontend - - Backend server: `api.snowball.com` - - Frontend app: `dashboard.snowball.com` + - Backend server: `api.snowballtools.com` + - Frontend app: `dashboard.snowballtools.com` - Set the following values in [.env](packages/frontend/.env) file - ``` + + ```env # Backend server endpoint - REACT_APP_SERVER_URL = 'https://api.snowball.com' + REACT_APP_SERVER_URL = 'https://api.snowballtools.com' ``` - Sign in to [wallet connect](https://cloud.walletconnect.com/sign-in) to create a project ID - Create a project and add information to use wallet connect SDK - Add project name and select project type as `App` - - Set project home page URL to `https://dashboard.snowball.com` + - Set project home page URL to `https://dashboard.snowballtools.com` - On creation of project, use the `Project ID` and set it in `REACT_APP_WALLET_CONNECT_ID` in [.env](packages/frontend/.env) file - ```env - REACT_APP_WALLET_CONNECT_ID = - ``` + + ```env + REACT_APP_WALLET_CONNECT_ID = + ``` - Build the React application + ```bash yarn build ``` - Use a web server for hosting static built files + ```bash python3 -m http.server -d build 3000 ``` -### Development +### Frontend Development - Copy the graphQL endpoint from terminal and add the endpoint in the [.env](packages/frontend/.env) file present in `packages/frontend` + ```env REACT_APP_SERVER_URL = 'http://localhost:8000' ``` @@ -223,9 +242,10 @@ - Add project name and select project type as `App` - Project home page URL is not required to be set - On creation of project, use the `Project ID` and set it in `REACT_APP_WALLET_CONNECT_ID` in [.env](packages/frontend/.env) file - ```env - REACT_APP_WALLET_CONNECT_ID = - ``` + + ```env + REACT_APP_WALLET_CONNECT_ID = + ``` - Start the React application