Skip to content

blankdotspace/space-system

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Blankspace

A platform where communities build their home on Farcaster.

Blankspace gives token communities, DAOs, and Farcaster channels a customizable homebase with community tools (fidgets) for governance, token management, feeds, and more. Each community gets their own branded experience with custom themes, navigation, and pages.

Initially funded by a grant from Nouns DAO. Forked from herocast in April 2024.

Docs

📚 View Full Documentation

Quick links:

Documentation source: docs/ • Docusaurus site: docs-site/

What is Farcaster?

A protocol for decentralized social apps: https://www.farcaster.xyz

🏗️ Dev Setup

  1. Clone the repo

    git clone https://github.com/blankdotspace/space-system.git
    cd space-system
  2. Install Supabase CLI

    On macOS:

    brew install supabase/tap/supabase
    brew install --cask docker
    open /Applications/Docker.app

    Wait for Docker Desktop to finish initializing before continuing.

    On Linux (Debian/Ubuntu):

    # Install Homebrew if needed
    /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
    
    # Install Supabase
    brew install supabase/tap/supabase
    
    # Install Docker
    sudo apt-get update
    sudo apt-get install -y docker.io docker-compose-plugin
    sudo systemctl enable --now docker
    sudo usermod -aG docker "$USER"

    Log out/in for Docker group membership to take effect.

  3. Install dependencies

    yarn install
  4. Set up environment variables

    Create .env.development.local with:

    • NEYNAR_API_KEY - Neynar API
    • NEXT_PUBLIC_ALCHEMY_API_KEY - Alchemy
    • ETHERSCAN_API_KEY - Etherscan
    • COINGECKO_API_KEY - CoinGecko
    • CLANKER_API_KEY - Request from the Blankspace or Clanker team
    • YOUTUBE_API_KEY - YouTube API
    • NEXT_PUBLIC_APP_FID + APP_MNEMONIC - Your Farcaster account
    • Supabase keys (from step 5)
  5. Start Supabase and run migrations

    supabase start
    supabase db reset

    Use the API URL for NEXT_PUBLIC_SUPABASE_URL and anon key for NEXT_PUBLIC_SUPABASE_ANON_KEY.

  6. Seed the local database

    yarn seed

    This creates storage buckets, community configs, domain mappings, and NavPage registrations.

    Verify seeding worked:

    yarn seed --check
  7. Run the test suite

    yarn test
  8. Build and run

    cp .env.development.local .env.local
    yarn build
    yarn dev

Contributing

See the contributing docs for how to add to the codebase. Register on Scout Game to earn points for contributions to repos in the blankdotspace org.

License

Blankspace is released under the GPL-3.0 License. Feel free to fork and modify—just be sure any version you release uses the GPL-3.0 License too.

Made with ❤️ by the Blankspace team & community.

Questions or feedback? Create a GitHub issue or contact us in Discord

About

Space systems - customizable farcaster clients

Topics

Resources

License

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 23