From 53ac476a56e5707e56f87a9a0798633d068a2ce7 Mon Sep 17 00:00:00 2001 From: Atris Date: Tue, 10 Oct 2023 15:32:59 +0200 Subject: [PATCH 1/2] docs: update .env.examples --- packages/builder/.env.example | 71 +++++++++++++++------------- packages/grant-explorer/.env.example | 60 ++++++++++++++--------- packages/round-manager/.env.example | 68 +++++++++++++++++--------- 3 files changed, 120 insertions(+), 79 deletions(-) diff --git a/packages/builder/.env.example b/packages/builder/.env.example index 3c02a049a6..c054814a50 100644 --- a/packages/builder/.env.example +++ b/packages/builder/.env.example @@ -1,51 +1,54 @@ -# Builder-specific env vars -REACT_APP_PUBLIC_GITHUB_CLIENT_ID= -REACT_APP_PUBLIC_GITHUB_CALLBACK= -REACT_APP_PASSPORT_IAM_URL= -REACT_APP_PASSPORT_PROCEDURE_URL= -REACT_APP_PUBLIC_PASSPORT_TWITTER_CALLBACK= -REACT_APP_PASSPORT_IAM_SERVER= -REACT_APP_LOCALCHAIN= -REACT_APP_DISABLE_PROJECTS_MARKDOWN= - -# Shared env vars -REACT_APP_ENV= +# development for local, production for prod builds +REACT_APP_ENV=development +# Bring your own API key REACT_APP_ALCHEMY_ID= REACT_APP_INFURA_ID= REACT_APP_WALLETCONNECT_ID= REACT_APP_WALLETCONNECT_PROJECT_ID= -REACT_APP_ALLOW_URL_DEBUG_MODE= -REACT_APP_DEBUG_MODE= - -REACT_APP_ALLO_API_URL= +# Get your credentials at https://www.pinata.cloud/ +REACT_APP_PINATA_GATEWAY= +REACT_APP_PINATA_JWT= -REACT_APP_GRANT_EXPLORER= +# Get your own keys at https://scorer.gitcoin.co +REACT_APP_PASSPORT_API_ENDPOINT="https://api.scorer.gitcoin.co" +REACT_APP_PASSPORT_API_COMMUNITY_ID= +REACT_APP_PASSPORT_API_KEY= +# Allow overriding permissions checks by appending ?debug=true to the URL +REACT_APP_ALLOW_URL_DEBUG_MODE=true + +# Disable permission checks by default +REACT_APP_DEBUG_MODE=false + +# URL of the indexer. http://localhost:8080 for local indexer +REACT_APP_ALLO_API_URL="https://indexer-production.fly.dev" + +# Subgraph URLs +REACT_APP_SUBGRAPH_ARBITRUM_API="https://api.thegraph.com/subgraphs/name/gitcoinco/gitcoin-grants-arbitrum-one" +REACT_APP_SUBGRAPH_ARBITRUM_GOERLI_API="https://api.thegraph.com/subgraphs/name/gitcoinco/grants-round-arbitrum-goerli" +REACT_APP_SUBGRAPH_AVALANCHE_API="https://api.thegraph.com/subgraphs/name/gitcoinco/grants-round-avalanche-mainnet" +REACT_APP_SUBGRAPH_FANTOM_MAINNET_API="https://api.thegraph.com/subgraphs/name/gitcoinco/grants-round-fantom-mainnet" +REACT_APP_SUBGRAPH_FANTOM_TESTNET_API="https://api.thegraph.com/subgraphs/name/gitcoinco/grants-round-fantom-testnet" +REACT_APP_SUBGRAPH_FUJI_API="https://api.thegraph.com/subgraphs/name/gitcoinco/grants-round-fuji-testnet" +REACT_APP_SUBGRAPH_GOERLI_API="https://api.thegraph.com/subgraphs/name/gitcoinco/grants-round-goerli-testnet" +REACT_APP_SUBGRAPH_MAINNET_API="https://gateway.thegraph.com/api/db01d72285a54fa4864050a870e9b16d/subgraphs/id/Ba4YGqqyYVFd55zcQnXS3XYTjJARKe93LY6qNgFbrHQz" +REACT_APP_SUBGRAPH_OPTIMISM_MAINNET_API="https://api.thegraph.com/subgraphs/name/gitcoinco/grants-round-optimism-mainnet" +REACT_APP_SUBGRAPH_PGN_API="https://graph-gitcoin-mainnet.hirenodes.io/subgraphs/name/gitcoin/allo" +REACT_APP_SUBGRAPH_PGN_TESTNET_API="https://graph-gitcoin-testnet.hirenodes.io/subgraphs/name/gitcoin/allo" +REACT_APP_SUBGRAPH_POLYGON_API="https://api.thegraph.com/subgraphs/name/allo-protocol/grants-round-polygon" +REACT_APP_SUBGRAPH_POLYGON_MUMBAI_API="https://api.thegraph.com/subgraphs/name/allo-protocol/grants-round-mumbai" + +# Variables below are optional for local development REACT_APP_DATADOG_APPLICATION_ID= REACT_APP_DATADOG_CLIENT_TOKEN= REACT_APP_DATADOG_SERVICE= REACT_APP_DATADOG_SITE= -REACT_APP_PASSPORT_API_COMMUNITY_ID= -REACT_APP_PASSPORT_API_ENDPOINT= -REACT_APP_PASSPORT_API_KEY= - -REACT_APP_PINATA_GATEWAY= -REACT_APP_PINATA_JWT= - REACT_APP_SENTRY_AUTH_TOKEN= REACT_APP_SENTRY_DSN= -REACT_APP_SUBGRAPH_ARBITRUM_API= -REACT_APP_SUBGRAPH_ARBITRUM_GOERLI_API= -REACT_APP_SUBGRAPH_FANTOM_MAINNET_API= -REACT_APP_SUBGRAPH_FANTOM_TESTNET_API= -REACT_APP_SUBGRAPH_GOERLI_API= -REACT_APP_SUBGRAPH_MAINNET_API= -REACT_APP_SUBGRAPH_OPTIMISM_MAINNET_API= -REACT_APP_SUBGRAPH_PGN_API= -REACT_APP_SUBGRAPH_PGN_TESTNET_API= - REACT_APP_TAG_MANAGER= + +REACT_APP_INTERCOM_APP_ID= diff --git a/packages/grant-explorer/.env.example b/packages/grant-explorer/.env.example index c0abe712fe..c054814a50 100644 --- a/packages/grant-explorer/.env.example +++ b/packages/grant-explorer/.env.example @@ -1,40 +1,54 @@ -REACT_APP_ENV= +# development for local, production for prod builds +REACT_APP_ENV=development +# Bring your own API key REACT_APP_ALCHEMY_ID= REACT_APP_INFURA_ID= REACT_APP_WALLETCONNECT_ID= REACT_APP_WALLETCONNECT_PROJECT_ID= -REACT_APP_ALLOW_URL_DEBUG_MODE= -REACT_APP_DEBUG_MODE= - -REACT_APP_ALLO_API_URL= +# Get your credentials at https://www.pinata.cloud/ +REACT_APP_PINATA_GATEWAY= +REACT_APP_PINATA_JWT= -REACT_APP_GRANT_EXPLORER= +# Get your own keys at https://scorer.gitcoin.co +REACT_APP_PASSPORT_API_ENDPOINT="https://api.scorer.gitcoin.co" +REACT_APP_PASSPORT_API_COMMUNITY_ID= +REACT_APP_PASSPORT_API_KEY= +# Allow overriding permissions checks by appending ?debug=true to the URL +REACT_APP_ALLOW_URL_DEBUG_MODE=true + +# Disable permission checks by default +REACT_APP_DEBUG_MODE=false + +# URL of the indexer. http://localhost:8080 for local indexer +REACT_APP_ALLO_API_URL="https://indexer-production.fly.dev" + +# Subgraph URLs +REACT_APP_SUBGRAPH_ARBITRUM_API="https://api.thegraph.com/subgraphs/name/gitcoinco/gitcoin-grants-arbitrum-one" +REACT_APP_SUBGRAPH_ARBITRUM_GOERLI_API="https://api.thegraph.com/subgraphs/name/gitcoinco/grants-round-arbitrum-goerli" +REACT_APP_SUBGRAPH_AVALANCHE_API="https://api.thegraph.com/subgraphs/name/gitcoinco/grants-round-avalanche-mainnet" +REACT_APP_SUBGRAPH_FANTOM_MAINNET_API="https://api.thegraph.com/subgraphs/name/gitcoinco/grants-round-fantom-mainnet" +REACT_APP_SUBGRAPH_FANTOM_TESTNET_API="https://api.thegraph.com/subgraphs/name/gitcoinco/grants-round-fantom-testnet" +REACT_APP_SUBGRAPH_FUJI_API="https://api.thegraph.com/subgraphs/name/gitcoinco/grants-round-fuji-testnet" +REACT_APP_SUBGRAPH_GOERLI_API="https://api.thegraph.com/subgraphs/name/gitcoinco/grants-round-goerli-testnet" +REACT_APP_SUBGRAPH_MAINNET_API="https://gateway.thegraph.com/api/db01d72285a54fa4864050a870e9b16d/subgraphs/id/Ba4YGqqyYVFd55zcQnXS3XYTjJARKe93LY6qNgFbrHQz" +REACT_APP_SUBGRAPH_OPTIMISM_MAINNET_API="https://api.thegraph.com/subgraphs/name/gitcoinco/grants-round-optimism-mainnet" +REACT_APP_SUBGRAPH_PGN_API="https://graph-gitcoin-mainnet.hirenodes.io/subgraphs/name/gitcoin/allo" +REACT_APP_SUBGRAPH_PGN_TESTNET_API="https://graph-gitcoin-testnet.hirenodes.io/subgraphs/name/gitcoin/allo" +REACT_APP_SUBGRAPH_POLYGON_API="https://api.thegraph.com/subgraphs/name/allo-protocol/grants-round-polygon" +REACT_APP_SUBGRAPH_POLYGON_MUMBAI_API="https://api.thegraph.com/subgraphs/name/allo-protocol/grants-round-mumbai" + +# Variables below are optional for local development REACT_APP_DATADOG_APPLICATION_ID= REACT_APP_DATADOG_CLIENT_TOKEN= REACT_APP_DATADOG_SERVICE= REACT_APP_DATADOG_SITE= -REACT_APP_PASSPORT_API_COMMUNITY_ID= -REACT_APP_PASSPORT_API_ENDPOINT= -REACT_APP_PASSPORT_API_KEY= - -REACT_APP_PINATA_GATEWAY= -REACT_APP_PINATA_JWT= - REACT_APP_SENTRY_AUTH_TOKEN= REACT_APP_SENTRY_DSN= -REACT_APP_SUBGRAPH_ARBITRUM_API= -REACT_APP_SUBGRAPH_ARBITRUM_GOERLI_API= -REACT_APP_SUBGRAPH_FANTOM_MAINNET_API= -REACT_APP_SUBGRAPH_FANTOM_TESTNET_API= -REACT_APP_SUBGRAPH_GOERLI_API= -REACT_APP_SUBGRAPH_MAINNET_API= -REACT_APP_SUBGRAPH_OPTIMISM_MAINNET_API= -REACT_APP_SUBGRAPH_PGN_API= -REACT_APP_SUBGRAPH_PGN_TESTNET_API= - REACT_APP_TAG_MANAGER= + +REACT_APP_INTERCOM_APP_ID= diff --git a/packages/round-manager/.env.example b/packages/round-manager/.env.example index c0abe712fe..96993f89a1 100644 --- a/packages/round-manager/.env.example +++ b/packages/round-manager/.env.example @@ -1,40 +1,64 @@ -REACT_APP_ENV= +#### Round-manager specific: +REACT_APP_BUILDER_URL="https://builder.gitcoin.co" +REACT_APP_GRANT_EXPLORER="https://explorer.gitcoin.co" + +# Whether to enable direct grants functionality. Cannot be off, included for posterity. +REACT_APP_DIRECT_GRANT_ENABLED="true" + +#### End round-manager specific + +# development for local, production for prod builds +REACT_APP_ENV=development + +# Bring your own API key REACT_APP_ALCHEMY_ID= REACT_APP_INFURA_ID= REACT_APP_WALLETCONNECT_ID= REACT_APP_WALLETCONNECT_PROJECT_ID= -REACT_APP_ALLOW_URL_DEBUG_MODE= -REACT_APP_DEBUG_MODE= +# Get your credentials at https://www.pinata.cloud/ +REACT_APP_PINATA_GATEWAY= +REACT_APP_PINATA_JWT= + +# Get your own keys at https://scorer.gitcoin.co +REACT_APP_PASSPORT_API_ENDPOINT="https://api.scorer.gitcoin.co" +REACT_APP_PASSPORT_API_COMMUNITY_ID= +REACT_APP_PASSPORT_API_KEY= + +# Allow overriding permissions checks by appending ?debug=true to the URL +REACT_APP_ALLOW_URL_DEBUG_MODE=true -REACT_APP_ALLO_API_URL= +# Disable permission checks by default +REACT_APP_DEBUG_MODE=false -REACT_APP_GRANT_EXPLORER= +# URL of the indexer. http://localhost:8080 for local indexer +REACT_APP_ALLO_API_URL="https://indexer-production.fly.dev" +# Subgraph URLs +REACT_APP_SUBGRAPH_ARBITRUM_API="https://api.thegraph.com/subgraphs/name/gitcoinco/gitcoin-grants-arbitrum-one" +REACT_APP_SUBGRAPH_ARBITRUM_GOERLI_API="https://api.thegraph.com/subgraphs/name/gitcoinco/grants-round-arbitrum-goerli" +REACT_APP_SUBGRAPH_AVALANCHE_API="https://api.thegraph.com/subgraphs/name/gitcoinco/grants-round-avalanche-mainnet" +REACT_APP_SUBGRAPH_FANTOM_MAINNET_API="https://api.thegraph.com/subgraphs/name/gitcoinco/grants-round-fantom-mainnet" +REACT_APP_SUBGRAPH_FANTOM_TESTNET_API="https://api.thegraph.com/subgraphs/name/gitcoinco/grants-round-fantom-testnet" +REACT_APP_SUBGRAPH_FUJI_API="https://api.thegraph.com/subgraphs/name/gitcoinco/grants-round-fuji-testnet" +REACT_APP_SUBGRAPH_GOERLI_API="https://api.thegraph.com/subgraphs/name/gitcoinco/grants-round-goerli-testnet" +REACT_APP_SUBGRAPH_MAINNET_API="https://gateway.thegraph.com/api/db01d72285a54fa4864050a870e9b16d/subgraphs/id/Ba4YGqqyYVFd55zcQnXS3XYTjJARKe93LY6qNgFbrHQz" +REACT_APP_SUBGRAPH_OPTIMISM_MAINNET_API="https://api.thegraph.com/subgraphs/name/gitcoinco/grants-round-optimism-mainnet" +REACT_APP_SUBGRAPH_PGN_API="https://graph-gitcoin-mainnet.hirenodes.io/subgraphs/name/gitcoin/allo" +REACT_APP_SUBGRAPH_PGN_TESTNET_API="https://graph-gitcoin-testnet.hirenodes.io/subgraphs/name/gitcoin/allo" +REACT_APP_SUBGRAPH_POLYGON_API="https://api.thegraph.com/subgraphs/name/allo-protocol/grants-round-polygon" +REACT_APP_SUBGRAPH_POLYGON_MUMBAI_API="https://api.thegraph.com/subgraphs/name/allo-protocol/grants-round-mumbai" + +# Variables below are optional for local development REACT_APP_DATADOG_APPLICATION_ID= REACT_APP_DATADOG_CLIENT_TOKEN= REACT_APP_DATADOG_SERVICE= REACT_APP_DATADOG_SITE= -REACT_APP_PASSPORT_API_COMMUNITY_ID= -REACT_APP_PASSPORT_API_ENDPOINT= -REACT_APP_PASSPORT_API_KEY= - -REACT_APP_PINATA_GATEWAY= -REACT_APP_PINATA_JWT= - REACT_APP_SENTRY_AUTH_TOKEN= REACT_APP_SENTRY_DSN= -REACT_APP_SUBGRAPH_ARBITRUM_API= -REACT_APP_SUBGRAPH_ARBITRUM_GOERLI_API= -REACT_APP_SUBGRAPH_FANTOM_MAINNET_API= -REACT_APP_SUBGRAPH_FANTOM_TESTNET_API= -REACT_APP_SUBGRAPH_GOERLI_API= -REACT_APP_SUBGRAPH_MAINNET_API= -REACT_APP_SUBGRAPH_OPTIMISM_MAINNET_API= -REACT_APP_SUBGRAPH_PGN_API= -REACT_APP_SUBGRAPH_PGN_TESTNET_API= - REACT_APP_TAG_MANAGER= + +REACT_APP_INTERCOM_APP_ID= From f351860106047f5d0f096b68163d880fda242720 Mon Sep 17 00:00:00 2001 From: Atris Date: Tue, 10 Oct 2023 17:45:12 +0200 Subject: [PATCH 2/2] docs: update passport guidance --- packages/builder/.env.example | 7 ++++--- packages/grant-explorer/.env.example | 7 ++++--- packages/round-manager/.env.example | 7 ++++--- 3 files changed, 12 insertions(+), 9 deletions(-) diff --git a/packages/builder/.env.example b/packages/builder/.env.example index c054814a50..6af20f5585 100644 --- a/packages/builder/.env.example +++ b/packages/builder/.env.example @@ -11,10 +11,11 @@ REACT_APP_WALLETCONNECT_PROJECT_ID= REACT_APP_PINATA_GATEWAY= REACT_APP_PINATA_JWT= -# Get your own keys at https://scorer.gitcoin.co -REACT_APP_PASSPORT_API_ENDPOINT="https://api.scorer.gitcoin.co" -REACT_APP_PASSPORT_API_COMMUNITY_ID= +# Get your own key at https://scorer.gitcoin.co REACT_APP_PASSPORT_API_KEY= +REACT_APP_PASSPORT_API_ENDPOINT="https://api.scorer.gitcoin.co" +# This is what the production indexer uses +REACT_APP_PASSPORT_API_COMMUNITY_ID="335" # Allow overriding permissions checks by appending ?debug=true to the URL REACT_APP_ALLOW_URL_DEBUG_MODE=true diff --git a/packages/grant-explorer/.env.example b/packages/grant-explorer/.env.example index c054814a50..6af20f5585 100644 --- a/packages/grant-explorer/.env.example +++ b/packages/grant-explorer/.env.example @@ -11,10 +11,11 @@ REACT_APP_WALLETCONNECT_PROJECT_ID= REACT_APP_PINATA_GATEWAY= REACT_APP_PINATA_JWT= -# Get your own keys at https://scorer.gitcoin.co -REACT_APP_PASSPORT_API_ENDPOINT="https://api.scorer.gitcoin.co" -REACT_APP_PASSPORT_API_COMMUNITY_ID= +# Get your own key at https://scorer.gitcoin.co REACT_APP_PASSPORT_API_KEY= +REACT_APP_PASSPORT_API_ENDPOINT="https://api.scorer.gitcoin.co" +# This is what the production indexer uses +REACT_APP_PASSPORT_API_COMMUNITY_ID="335" # Allow overriding permissions checks by appending ?debug=true to the URL REACT_APP_ALLOW_URL_DEBUG_MODE=true diff --git a/packages/round-manager/.env.example b/packages/round-manager/.env.example index 96993f89a1..9472e040d8 100644 --- a/packages/round-manager/.env.example +++ b/packages/round-manager/.env.example @@ -21,10 +21,11 @@ REACT_APP_WALLETCONNECT_PROJECT_ID= REACT_APP_PINATA_GATEWAY= REACT_APP_PINATA_JWT= -# Get your own keys at https://scorer.gitcoin.co -REACT_APP_PASSPORT_API_ENDPOINT="https://api.scorer.gitcoin.co" -REACT_APP_PASSPORT_API_COMMUNITY_ID= +# Get your own key at https://scorer.gitcoin.co REACT_APP_PASSPORT_API_KEY= +REACT_APP_PASSPORT_API_ENDPOINT="https://api.scorer.gitcoin.co" +# This is what the production indexer uses +REACT_APP_PASSPORT_API_COMMUNITY_ID="335" # Allow overriding permissions checks by appending ?debug=true to the URL REACT_APP_ALLOW_URL_DEBUG_MODE=true