[!NOTE] The project is under active development.

<br /> <p align="center"> <a href="https://efp.app" target="_blank" rel="noopener noreferrer"> <img width="275" src="https://docs.efp.app/logo.png" alt="EFP logo" /> </a> </p> <p align="center"> <a href="https://pr.new/ethereumfollowprotocol/app"><img src="https://developer.stackblitz.com/img/start_pr_dark_small.svg" alt="Start new PR in StackBlitz Codeflow" /></a> <a href="https://discord.com/invite/ZUyG3mSXFD"><img src="https://img.shields.io/badge/chat-discord-blue?style=flat&logo=discord" alt="discord chat" /></a> <a href="https://x.com/efp"><img src="https://img.shields.io/twitter/follow/efp?label=%40efp&style=social&link=https%3A%2F%2Fx.com%2Fefp" alt="x account" /></a> </p> <h1 align="center" style="font-size: 2.75rem; font-weight: 900; color: white;">Ethereum Follow Protocol Web App</h1>

Overview

The Ethereum Follow Protocol (EFP) is a native Ethereum protocol designed for following and tagging Ethereum addresses. This web application serves as the interface for interacting with the protocol, providing users with a seamless experience to manage their social graph on the blockchain.

Important Links

Documentation: docs.efp.app
Follow us on 𝕏: @efp
Join our Discord: Discord

Important links

Documentation: docs.efp.app

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

Contributing

We welcome contributions! Please see our Contributing Guidelines for more details.

License

This project is licensed under the MIT License. See the LICENSE file for more information.

Contact

For any inquiries, please contact the project maintainer at encrypted@ethfollow.xyz.

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

This README provides a comprehensive overview of the Ethereum Follow Protocol Web App, including setup instructions, important links, and contribution guidelines. Feel free to reach out if you have any questions or need further assistance.

App

Install / Use

README