SuperteamDAO/earn: An open source platform connecting crypto founders with elite talent to create bounties, and accelerate project completion

!Superteam Earn Icon

Superteam Earn

An open source platform connecting crypto founders with elite talent to create bounties, and accelerate project completion

!Project Status: Active !GitHub issues !GitHub pull requests

• Superteam Earn website - https://earn.superteam.fun
• Superteam website - https://superteam.fun
• Superteam Earn X/Twitter - https://x.com/superteamearn

🛠️Development Setup

Prerequisites

• NodeJS
• MySQL
• pnpm
• Privy
• Cloudinary
• Resend

Getting Started

1. Clone the repository into a public Github repository (or fork it):

git clone https://github.com/SuperteamDAO/earn.git

1. Navigate to the project directory:

cd earn

1. Install the dependencies with the pnpm version pinned in package.json:

corepack pnpm install --frozen-lockfile

Use corepack pnpm add for dependency changes and commit both package.json and pnpm-lock.yaml. Run corepack pnpm check:lockfile before pushing. The commit hook and CI also check that the lockfile matches the manifest and overrides. Vercel uses the same pinned version and frozen install.

Do not regenerate the lockfile with a different global pnpm version: pnpm 11 ignores the pnpm.overrides field used by this repository. Upgrade pnpm deliberately, migrating its configuration and validating a frozen install together. If Corepack is unavailable, install it before running these commands.

1. Install the MariaDB adapter (required for local MySQL development):

pnpm add @prisma/adapter-mariadb

Then, uncomment the MariaDB adapter code in src/prisma.ts: - Line 1: Uncomment the PrismaMariaDb import - Lines 35-44: Uncomment the URL parsing and adapter creation code - Line 47: Uncomment the adapter parameter in PrismaClient

1. Set up your .env file.

• Start by copying the .env.example file to a new file named .env. This file will store your local environment settings.
• Database setup:

The app automatically detects your database type based on DATABASE_URL. Choose your platform:

brew install mysql

brew services start mysql

mysql -u root -e "CREATE DATABASE earn_db"

DATABASE_URL='mysql://root@localhost:3306/earn_db'

# Using Chocolatey
  choco install mysql
# OR using winget
  winget install Oracle.MySQL

net start MySQL

mysql -u root -p -e "CREATE DATABASE earn_db"

DATABASE_URL='mysql://root:YOUR_PASSWORD@localhost:3306/earn_db'

# Install MySQL
  sudo apt update
  sudo apt install mysql-server
# Start MySQL service
  sudo systemctl start mysql
  sudo systemctl enable mysql
# Secure installation (optional but recommended)
  sudo mysql_secure_installation
# Create database
  sudo mysql -e "CREATE DATABASE earn_db"
# Create user (optional, for better security)
  sudo mysql -e "CREATE USER 'earnuser'@'localhost' IDENTIFIED BY 'your_password';"
  sudo mysql -e "GRANT ALL PRIVILEGES ON earn_db.* TO 'earnuser'@'localhost';"
  sudo mysql -e "FLUSH PRIVILEGES;"

# Install MySQL
  sudo dnf install mysql-server  # or 'yum' for older versions
# Start MySQL service
  sudo systemctl start mysqld
  sudo systemctl enable mysqld
# Create database
  sudo mysql -e "CREATE DATABASE earn_db"

# If using root:
  DATABASE_URL='mysql://root@localhost:3306/earn_db'
# If you created a user:
  DATABASE_URL='mysql://earnuser:your_password@localhost:3306/earn_db'

After setting up MySQL, generate Prisma client:

npx prisma generate && npx prisma db push

Option 2: Cloud MySQL Database

If you prefer not to run MySQL locally, you can use cloud services (all have free tiers): - Setup MySQL with Railway - Setup MySQL with Render - Setup MySQL with PlanetScale

Then set DATABASE_URL in .env with the connection string from your cloud provider.

• Privy setup:

• Resend setup:

• Cloudinary setup:

• Jupiter API setup:

• Set up Solana RPC WebSocket URL:

NEXT_PUBLIC_RPC_WS_URL='wss://api.mainnet-beta.solana.com?api-key=abc-xyz'

Facing an issue? Please feel free to reach out to Jill or Abhishek on Twitter.

1. Run the development server

pnpm dev

⭐Contributing

We welcome contributions from everyone! Whether it's submitting an issue, a pull request, or suggesting new ideas, your input is highly valued. Check out our contributing guide for guidelines on how to proceed.

Facing an issue? Please feel free to reach out to Jill or Abhishek on Twitter.

Why should you contribute to Earn?

• Consistent, good-quality contributions will earn you contributor status in the Superteam of your preference! Contributors get special access to channels on Discord, preferential entry to events, and is a great stepping stone to becoming a Superteam member.
• Get XP if you're already a Superteam Member or Contributor
• Unwavering love and support from the Superteam Earn team!

Contributors

📊Repo Activity