Skip to content

Latest commit

 

History

History
92 lines (56 loc) · 4.53 KB

README.md

File metadata and controls

92 lines (56 loc) · 4.53 KB
Raw
zephyr-logo

Zephyr is an opinionated starter kit for web3 frontends.

Made with 🖤 in Kyoto, Japan by Sol Irvine

What it does

Zephyr is a useful starting point for web3 developers who are building frontend web apps that interact with on-chain services.

Out of the box, Zephyr:

  • Allows a user to sign up or sign in, using any of the methods available via Clerk .
  • Requires a user to submit and verify their username, full name, and email address after signing up.
  • Allows a user to enter any EVM-compatible on-chain accounts. The address is verified in real-time, and any problems with the address are surfaced to the user.
  • Allows a user to save a valid on-chain account to the database.
  • Displays a list of saved on-chain accounts from the database.

The functionality above is provided to give developers a useful jumping-off point for their own explorations and enhancements. Zephyr tries to strike the balance between showing real-world examples without being too difficult to modify to your needs.

What's included

Getting started

Create an account on Clerk .

  • Create a new application on Clerk.
  • Save a copy of your NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY and CLERK_SECRET_KEY somewhere secure

Create an account on Neon .

  • Create a project on Neon.
  • Save a copy of the connection string for your new project somewhere secure.

Generate a new repository from this template.

  • Install dependencies: yarn install .
  • Create a file called .env.development.local in the project root, and add the following environment variables:
NEXT_PUBLIC_APP_NAME={Your app name}
NEXT_PUBLIC_APP_DESCRIPTION={Your app description}
NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY={Supplied by Clerk}
CLERK_SECRET_KEY={Supplied by Clerk}
DATABASE_URL={Your Postgres database URL from Neon}

Change the project name in package.json to your project name, and update the README.md file to fit your project.

Setting up your database

Zephyr includes an optional data schema that illustrates how to configure and seed a database with Drizzle/Neon. The included data provides a basic representation of EVM-ecosystem chains.

This data is used to drive Zephyr's default UI, which provides users with a way to add their on-chain addresses. You may find this useful when building your own web3 app. If not, you are welcome to skip the following steps.

For your reference, the data schema that we'll be installing is represented below.

zephyr-erd

You can review the code that establishes this schema in db/schema.ts . You are welcome to modify it to fit your app's needs.

The seed data we'll use to populate the database is in db/seed-fixtures.ts . Again, feel free to enhance or modify. If you're looking for additional chains, try the ethereum-lists/chains project.

Pushing seed data into your database

To test push your schema into Neon without committing a migration, use yarn drizzle:push .

  • When you're ready to commit your first migration, use yarn drizzle:generate .
  • Note that after you commit your first migration, you'll need to commit a new migration every time you change your schema going forward.

To see your data in Drizzle Studio, use yarn drizzle:studio .

Running Zephyr locally

We chose to build Zephyr with yarn, but you can substitute whatever package manager you prefer.

Run yarn dev to fire up a development server.

  • If you prefer Vercel CLI as your dev server, use vercel dev or vc dev instead of yarn dev .

Go to http://localhost:3000 to see Zephyr in action. You should be prompted to sign up.