Ethereum Follow Protocol Web App

A native Ethereum protocol for following and tagging Ethereum accounts.

Important links

Documentation: docs.ethfollow.xyz

Getting started with development

Prerequisites

Node.js LTS (LTS which is currently 20.x)
Bun runtime (latest version)

Installation

git clone https://github.com/ethereumfollowprotocol/app.git && cd app

Note

If vscode extensions behave weirdly or stops giving type hints, run ⌘+⇧+P and type > Developer: Restart Extension Host to restart the extension host.

# upgrade bun to make sure you have the latest version
bun upgrade
# then install all dependencies
bun install

Environment Variables

cp .env.example .env

Now you should be able to run the following without getting any errors:

bun lint && bun format && bun typecheck && bun run build

Directory Structure

├─ public # static assets - https://nextjs.org/docs/app/building-your-application/optimizing/static-assets
├─ src
│  ├─ components # reusable/shared components
│  ├─ lib # reusable/shared non-jsx functions
|  ├─ hooks # reusable/shared hooks
│  ├─ app # https://nextjs.org/docs/getting-started/project-structure#app-routing-conventions
|    ├─ api/<pathname>/route.ts # https://nextjs.org/docs/app/api-reference/file-conventions/route
│    ├─ [<route>]/layout.tsx # https://nextjs.org/docs/app/api-reference/file-conventions/layout
│    ├─ [<route>]/page.tsx # https://nextjs.org/docs/app/api-reference/file-conventions/page

TODO: Continue documentation

Follow @efp on 𝕏 for updates and join the Discord to get involved.