Speedrun Ethereum

New version of Speedrun Ethereum built with Scaffold-ETH 2. An expanded experience for builders where you'll be able to unlock your builder profile after completing a few challenges. This will open the gates to:

• Interact with other BuidlGuidl curriculums like ETH Tech Tree and BuidlGuidl CTF
• Share your builds and discover what other builders are up to
• Earn badges

You can find the repository containing the challenges here.

Requirements

Before you begin, you need to install the following tools:

• Node (>= v22.18.0)
• Yarn (v1 or v2+)
• Git
• Docker Engine

Development Quickstart

1. Install dependencies

yarn install

2. Spin up the Postgres database service + create database + seed

docker compose up -d
yarn drizzle-kit migrate
yarn db:seed

3. Start your NextJS app:

yarn start

Visit your app on: http://localhost:3000.

4. You can explore the database with:

yarn drizzle-kit studio

Database Information

We are using Drizzle with Postgres for database management. You can run drizzle-kit commands from the root with yarn drizzle-kit.

Database Migration

Anytime we update the schema in packages/nextjs/services/database/config/schema.ts, we can generate a migration with:

yarn drizzle-kit generate

Then we can apply the migration with:

yarn drizzle-kit migrate

We also need to make sure we commit the migration to the repo.

Database (dev info)

To iterate fast on the database locally:

• Tweak the schema in schema.ts
• Run yarn drizzle-kit push to apply the changes.
• Copy seed.data.example.ts to seed.data.ts, tweak as needed and run yarn db:seed (will delete existing data)

Firebase image upload

1. In the Firebase Console, go to "Project settings" (the gear icon)

2. Navigate to the "Service accounts" tab

3. Click "Generate new private key" for the Firebase Admin SDK

4. Save the JSON file securely

5. In .env.local file in the packages/nextjs directory, add the following variables:

FIREBASE_SERVICE_ACCOUNT_KEY='{
  "type": "service_account",
  "project_id": "your-project-id",
  ...,
}'

FIREBASE_STORAGE_BUCKET=your-project-id.appspot.com

Replace the content of FIREBASE_SERVICE_ACCOUNT_KEY with the JSON content from your service account key file (wrap the json in single quotes).

The FIREBASE_STORAGE_BUCKET should be set to your Firebase Storage bucket name, typically in the format your-project-id.appspot.com.

Testing

This project uses Playwright with Synpress for end-to-end testing with MetaMask integration.

Running Tests

To run tests locally, you have two options:

1. Run tests in headless mode:

yarn next:test

2. Run tests with UI (interactive mode):

yarn next:test-ui

Test Setup Requirements

Before running tests, ensure you have:

1. Install Playwright browsers (only needed the first time):

   yarn next:playwright-install

2. Build wallet cache: Set up the Synpress cache for MetaMask integration

   yarn next:cache-synpress

3. Database running: Make sure your Postgres database is up and seeded

   docker compose up -d
   yarn drizzle-kit migrate
   yarn db:seed

Note: The tests will automatically start the dev server, so you don't need to run it manually.

Troubleshooting

Cache Issues

If you encounter an error like Error: Cache for 08a20e3c7fc77e6ae298 does not exist. Create it first!, you need to rename your cache folder:

1. Navigate to packages/nextjs/.cache-synpress/
2. Rename the existing cache folder to match the error message (e.g., rename 532f685e346606c2a803 to 08a20e3c7fc77e6ae298), or use this command from the root folder:

mv packages/nextjs/.cache-synpress/532f685e346606c2a803 packages/nextjs/.cache-synpress/08a20e3c7fc77e6ae298

User Registration Issues

Since tests register a test user, you may need to reset the database between test runs:

yarn db:seed

This will clear existing data and reseed the database with fresh test data.