Skip to content

Latest commit

 

History

History
84 lines (65 loc) · 3.56 KB

README.md

File metadata and controls

84 lines (65 loc) · 3.56 KB
Raw

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 Follow

Development Setup

Prerequisites

  • NodeJS
  • MySQL
  • pnpm

Getting Started

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

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

  2. Navigate to the project directory:

    cd earn

  3. Install the dependencies:

    pnpm i

  4. 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.

  • Use openssl rand -base64 32 to generate a key and add it under NEXTAUTH_SECRET in the .env file.

  • Database setup

    • Create a local MySQL instance and replace <user>, <pass>, <db-host>, and <db-port> with their applicable values.

      DATABASE_URL='mysql://<user>:<pass>@<db-host>:<db-port>'

    • If you don't want to create a local DB, then you can also consider using services like railway.app or render.

    • Generate prisma migrations & client.

      npx prisma migrate dev --name init && npx prisma generate

  • You have to set up resend to run the app:

    • Resend: To obtain your RESEND_API_KEY, visit the Resend dashboard. This credential is essential for setting up Email Auth.

NOTE: If you are facing any issues with setup, feel free to contact Abhishek

  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 Abhishek or Pratik

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