🏆 GrantPicks Documentation

GrantPicks is an innovative funding platform for Web3 projects that uses pairwise voting and budget boxing algorithms to ensure transparent, efficient, and fair distribution of grants.

📖 About GrantPicks

GrantPicks is a multichain application built on Soroban (Stellar) and NEAR networks that revolutionizes how projects receive funding. The platform combines:

• Pairwise Voting: Compare projects in pairs for better decision-making
• Budget Boxing Algorithm: Fair fund distribution based on voting results
• Vault Management: Secure fund handling with quick payouts
• KYC Compliance: Transparent and accountable funding process
• Multichain Support: Built on Stellar and NEAR networks

Key Features

• 🗳️ Democratic Voting: Community-driven project selection
• 💰 Transparent Funding: Open and trackable fund allocation
• 🔒 Secure Vaults: Safe fund management and payouts
• 🌐 Multichain: Support for multiple blockchain networks
• 📊 Real-time Tracking: Monitor ongoing and past funding rounds
• 👥 Role-based Access: Different user types with specific capabilities

🚀 Quick Start

Prerequisites

• Node.js >= 20.0
• Yarn package manager

Installation

# Clone the repository
git clone https://github.com/potlock/grantpicks.git
cd docs-grantpicks

# Install dependencies
yarn install

Development

# Start local development server
yarn start

This opens the documentation site at http://localhost:3000 with live reloading.

Build & Deploy

# Build for production
yarn build

# Serve locally
yarn serve

# Deploy to GitHub Pages
yarn deploy

📁 Project Structure

docs-grantpicks/
├── 📚 docs/                          # Main documentation content
│   ├── intro.md                      # Project overview and introduction
│   ├── user-guides/                  # User documentation
│   │   ├── getting-started.md        # Getting started guide
│   │   ├── exploring-rounds.md       # How to explore funding rounds
│   │   ├── pairwise-voting-explained.md # Voting system explanation
│   │   ├── getting-started-with-stellar.md # Stellar network guide
│   │   └── user-classes/             # Role-specific guides
│   │       ├── index.md              # User roles overview
│   │       ├── observers.md          # Observer role guide
│   │       ├── projects/             # Project owner guides
│   │       ├── round-managers/       # Round manager guides
│   │       └── voters/               # Voter guides
│   ├── developers/                   # Developer documentation
│   │   ├── forking-the-app.md       # How to fork the application
│   │   └── smart-contracts-stellar/ # Stellar smart contract docs
│   │       ├── index.md              # Smart contracts overview
│   │       ├── project-registry.md  # Project registry contract
│   │       └── rounds/              # Round contract documentation
│   └── extra/                        # Additional resources
│       └── glossary.md               # Terms and definitions
├── 🎨 src/                           # Source code and components
│   ├── components/                   # React components
│   │   └── HomepageFeatures/         # Homepage feature components
│   ├── css/                          # Custom styles
│   └── pages/                        # Custom pages
├── 📝 blog/                          # Blog posts and articles
├── 🖼️ static/                        # Static assets
│   ├── assets/                       # Images and media files
│   └── img/                          # Site images and icons
├── ⚙️ Configuration Files
│   ├── docusaurus.config.ts         # Docusaurus configuration
│   ├── sidebars.ts                  # Documentation sidebar structure
│   ├── package.json                 # Dependencies and scripts
│   └── tsconfig.json                # TypeScript configuration
└── 📄 README.md                     # This file

🎯 User Roles

🕵️ Observers

• Browse active and past grant rounds
• View project proposals and details
• Access public voting results and statistics

🗳️ Voters

• Participate in pairwise voting
• Track voting history
• Create challenges and fund vaulted rounds

💼 Projects

• Apply for funding rounds
• Edit project profiles
• Complete KYC compliance
• Receive funding payouts

👨‍💻 Round Managers

• Create and manage funding rounds
• Review and approve project applications
• Set up and trigger payouts
• Oversee round administration

🔗 Important Links

🌐 Live Applications

• GrantPicks App - Main application
• Documentation Site - This documentation
• POTLOCK - Parent organization

📚 Documentation

• Getting Started - Quick start guide
• User Guides - Comprehensive user documentation
• Developer Docs - Technical documentation
• Glossary - Terms and definitions

🛠️ Development

• GitHub Repository - Source code
• Smart Contracts - Contract documentation
• Forking Guide - How to fork the app

🏢 Organization

• POTLOCK GitHub - Organization profile
• All Features - Complete feature list

🛠️ Technology Stack

• Docusaurus 3.9.1 - Documentation framework
• React 19.0 - UI framework
• TypeScript 5.6.2 - Type safety
• MDX - Markdown with JSX support
• Local Search - Built-in search functionality

🤝 Contributing

We welcome contributions! Please see our GitHub repository for:

• Issue reporting
• Feature requests
• Pull requests
• Documentation improvements

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

🫕 Part of POTLOCK Ecosystem

GrantPicks is part of the POTLOCK open funding stack ecosystem, contributing to the broader mission of transparent and democratic funding in Web3.

---

Built with ❤️ by the POTLOCK team