Welcome to the Instructions Page

This page contains setup instructions for all required integrations.

Click on each section below to expand it and follow the steps carefully. We recommend going from top to bottom if this is your first time setting things up.

Instructions on upload your survey file directly to Github or Huggingface from our web app.

  1. Generate a Access Token on either your Github or Huggingface account. (Intructions can be found below on how to do that)
  2. Create a repository on Github or a space on Huggingface to upload the survey file to. (When creating a space on Huggingface, for Space SDK you want to choose Docker > Streamlit)
  3. Once you have completed both of these tasks, go to the Survey Builder page on our app.
  4. Click Export Survey, then upload to Huggingface or Github.
  5. Enter your repository or space name in the format username/repository-name and Access Token you generated at the beginning.
  6. Click Submit! This should give you a message on whether it successfully or unsuccessfully uploaded your survey file.

Instructions on how to generate an Access Token for Huggingface.

  1. Sign in at huggingface.co.
  2. Click profile > Settings.
  3. Click Access Tokens.
  4. Click Create new token with type Fine-grained.
  5. Give it a name, check repo write access, then Create token.
  6. Important: Copy and save it immediately.

Instructions on how to generate an Access Token for GitHub.

This Access Token is used to directly upload the survey to your GitHub repository.

  1. Go to github.com and sign in or create an account.
  2. Click your profile picture > Settings.
  3. Scroll down > Developer settings.
  4. Expand Personal access tokens > Tokens (classic).
  5. Click Generate new token (classic).
  6. Enter a name, select repo, and click Generate token.
  7. Important: Save the token—you won’t be able to view it again.

Instructions on how to host your survey using a Github repo through Streamlit.

  1. Once you have uploaded the survey file to GitHub, then go to Streamlit Sharing.
  2. Sign in with GitHub and click Create app.
  3. Set survey_script.py as the main file path.
  4. Click Deploy to launch the app! (This should give you a link to where people can now take your survey)

  1. Create a Piñata account at pinata.cloud.
  2. Generate an API key in the API Keys section.
  3. Create a JWT in the JWT Keys tab.
  4. Add the JWT token to Streamlit as PinataJWT in your secrets.

Follow these steps to set up Infura and connect to Sepolia.

  1. Go to infura.io and sign up.
  2. On the left-hand side, select Infura RPC.
  3. Click on Active Endpoints and select Ethereum Sepolia.
  4. Copy the HTTPS URL and save it so you do not have to return here.

Use Coinbase Wallet for Sepolia testnet setup.

  1. Download the Coinbase Wallet app.
  2. Tap “Create New Wallet” and back up your phrase.
  3. Ensure you're on the Sepolia Test Network.
  4. Copy your wallet address for faucets.

Steps to get testnet ETH:

These are instructions on how to deploy a smart contract.

  1. Go to Deploy Smart Contract
  2. Enter your wallet address, private key, and infura URL.
  3. Press Deploy Contract
  4. Copy the text after it says "Contract deployed successfully at:"
  5. Save this text somewhere since your will need to deploy a new contract if you lose it.

These are instructions on add secrets to a Huggingface space to enable submitting results to blockchain.

  1. Go to your Huggingface space and click on Settings in the top right-hand corner.
  2. Scroll down to Variables and secrets.
  3. Press New Secret.
  4. You will need to add 5 secrets with the following names: PinataJWT (The PinataJWT Token), infura (infura API URL), ContractAddress (Smart Contract Address), EthWallet (Etherium Wallet Address), and pk (Etherium Wallet Private Key)

These are instructions on how to Retrieve Survey Results.

  1. Go to Retrieve Survey Results
  2. Enter your smart contract address.
  3. Press Get Results