gitcoinco / qf-calculator

4 stars 1 forks source link

๐Ÿงฎ Quadratic Funding Calculator

๐Ÿ“‹ Overview

This project is a Streamlit-based web application that calculates and visualizes matching results for Quadratic Funding (QF) rounds. It compares standard Quadratic Funding with Connection-Oriented Cluster Matching (COCM) to provide insights into fund distribution.

โœจ Features

๐Ÿš€ Installation

  1. Clone the repository:

    git clone [repository-url]
    cd [repository-name]
  2. Install the required packages:

    pip install -r requirements.txt

๐Ÿ–ฅ๏ธ Usage

  1. Run the Streamlit app:

    streamlit run Home.py
  2. Access the app through your web browser, typically at http://localhost:8501

  3. Provide the round_id and chain_id as URL parameters:

    http://localhost:8501/?round_id=[ROUND_ID]&chain_id=[CHAIN_ID]

โš™๏ธ Configuration

๐Ÿ“ Files Description

๐Ÿ“ฆ Dependencies

๐Ÿš€ Deployment with Fly.io

This project is configured for deployment on Fly.io. Here are the steps to deploy:

  1. Install the Fly CLI: Follow the instructions at https://fly.io/docs/hands-on/install-flyctl/

  2. Login to Fly:

    fly auth login
  3. Navigate to your project directory and initialize the Fly app:

    fly launch
  4. Deploy the app:

    fly deploy
  5. Once deployed, you can access your app at https://qf-calculator.fly.dev

Remember to set up your environment variables and secrets in the Fly.io dashboard or using the Fly CLI before deployment.

For more detailed information on deploying Streamlit apps on Fly.io, refer to their documentation: https://fly.io/docs/app-guides/streamlit/