hey.xyz README

The project's README from github.com/slymnoyann/hey.xyz. As one markdown file: README.md.

Hey.xyz

Hey is a decentralized and permissionless social media application built with Lens Protocol.

Open Source Snapshot Notice

This repository represents the last publicly available open-source version of Hey.xyz before May 15, 2026.

Development and changes made to Hey.xyz after May 15, 2026 are currently not open source and are not included in this repository.

This repository is therefore preserved as a historical open-source snapshot of the Hey.xyz codebase as it existed before that date.


About

Hey is a decentralized social network built on top of the Lens Protocol.

The application provides a social experience where users can create profiles, publish content, interact with other users, and participate in a permissionless social network powered by blockchain technology.

This repository contains the source code for the open-source version of Hey that was available before May 15, 2026.

Important

This repository should be considered a historical snapshot, rather than the current production source code of Hey.xyz.

The production version of Hey.xyz may contain features, architectural changes, infrastructure changes, security improvements, and other modifications that are not present in this repository.


Open Source Status

Period Source Code Status
Before May 15, 2026 Open source
May 15, 2026 Last open-source development period
After May 15, 2026 Currently not open source

The purpose of this repository is to preserve and provide access to the codebase that was publicly available prior to the transition.

No claim is made that this repository represents the current implementation running on Hey.xyz.


Tech Stack

This version of Hey is built using modern web and Web3 technologies, including:

The repository is structured as a monorepo and contains the application source code and supporting development tooling.


Requirements

Before running the project locally, make sure you have the following installed:

Using NVM is recommended for managing Node.js versions.


Installation

1. Clone the repository

git clone https://github.com/slymnoyann/hey.xyz.git
cd hey.xyz

If you are using a fork or another copy of this repository, replace the URL accordingly.

2. Install Node.js

If the repository contains an .nvmrc file, you can use:

nvm install
nvm use

Verify your Node.js version:

node -v

3. Install pnpm

If pnpm is not already installed:

npm install -g pnpm

Verify the installation:

pnpm -v

4. Install dependencies

From the repository root:

pnpm install

Environment Variables

The application requires environment variables for local development and certain services.

Where .env.example files are provided, copy them to .env before starting the application.

For example:

cp .env.example .env

Depending on the package or application being used, additional environment configuration may be required.

Typical configuration may include:

Security

Never commit private keys, API secrets, database credentials, or other sensitive values to Git.

Use local .env files for development and properly managed secrets for production environments.


Development

Start the development environment with:

pnpm dev

Once the development server is running, open the local URL displayed in the terminal.


Build

To create a production build:

pnpm build

Type Checking

Run TypeScript type checking with:

pnpm typecheck

Linting and Formatting

Check the codebase for formatting and linting issues:

pnpm biome:check

Automatically fix supported formatting and linting issues:

pnpm biome:fix

Project Structure

The repository follows a monorepo-style structure.

Some of the main directories and files include:

.
├── .github/
├── .husky/
├── .vscode/
├── public/
├── script/
├── src/
├── .gitignore
├── .nvmrc
├── biome.json
├── ecosystem.config.cjs
├── generated.ts
├── index.html
├── package.json
├── pnpm-lock.yaml
├── possible-types.ts
├── tsconfig.json
└── vite.config.mjs

The exact structure may vary between historical commits and branches.


Maintenance Scripts

The repository includes several scripts for development and maintenance.

Clean the repository

node script/clean.mjs

This can be used to clean generated files and installed dependencies.

Update dependencies

node script/update-dependencies.mjs

Sort package files

node script/sort-package-json.mjs

Development Notes

This repository contains a historical version of Hey and may require adjustments to run against currently available third-party infrastructure.

In particular, external services and protocols may have changed since this version was published, including:

As a result, a successful local build does not necessarily mean that the application can be deployed to production without modification.


Contributing

Contributions to this historical snapshot are welcome through forks and pull requests where appropriate.

However, please keep in mind that this repository represents a historical open-source version of Hey and does not represent the current private development codebase of Hey.xyz.


Disclaimer

This repository is provided for archival, educational, research, and development purposes.

It represents the open-source Hey.xyz codebase available before May 15, 2026.

Features and development introduced after May 15, 2026 are currently not included because the corresponding source code is not publicly available.

The current Hey.xyz application may differ substantially from the code contained in this repository.


License

This project is released under the GNU Affero General Public License v3.0 (AGPL-3.0).

See the LICENSE file for the complete license text.


Historical Context

Hey was created as a decentralized and permissionless social network built with Lens Protocol.

This repository preserves an important point in the project's development history: the final open-source state of the application before May 15, 2026.

If you are studying the architecture, experimenting with Lens-based social applications, or interested in the evolution of decentralized social networks, this repository can serve as a reference implementation for that period.


Hey.xyz

A historical open-source snapshot of Hey before May 15, 2026. 🌿

hey.xyz (slymnoyann/hey.xyz)

Searching Database…

29.4K ·GitHub
这是什么?Hey 是一个基于 Lens Protocol 的去中心化、无需许可的社交媒体应用。这个仓库保存的是它在 2026 年 5 月 15 日之前最后的开源版本代码。
那这是我现在就能用的应用代码,还是一份旧拷贝?它刻意就是一份旧拷贝:这是一个历史快照,线上的 Hey.xyz 可能已经有很大不同。2026 年 5 月 15 日之后开发的内容都不开源,也不在这个仓库里。
我能在本地把它跑起来吗?搭建过程是什么样的?可以。安装 Node.js v22+、pnpm、PostgreSQL 和 Git,克隆仓库,把对应的 .env.example 复制为 .env,在根目录用 pnpm 安装依赖,然后运行 dev 脚本——它会在 4783 端口提供服务。
在它启动之前需要配置哪些东西?需要的是一组真实的服务配置,而不只是一个密钥:Lens 设置、PostgreSQL 连接、Redis、API 鉴权、钱包/私钥以及存储——具体取决于你运行的是 monorepo 中的哪个包。
就算它顺利编译通过,今天连上线上服务就真的能用吗?不一定。自这份快照以来,Lens API、GraphQL 和 RPC 端点、鉴权、存储甚至区块链网络都可能已经变了,所以编译成功也不代表生产环境能直接运行,可能还需要改动。
这份快照到底是给谁看的?用于存档、教学和研究:如果你在研究它的架构,或者想试验基于 Lens 的社交应用,README 把它当作那个时期的参考实现提供。
用户在 Hey 上究竟能做什么?创建个人资料、发布内容、与其他用户互动,并通过 Lens Protocol 参与一个由区块链技术驱动的、无需许可的社交网络。
它底层用的技术栈是什么?TypeScript,配合 React 和 Next.js、Tailwind CSS 和 GraphQL,区块链部分用 Wagmi 和 Viem,再加上 PostgreSQL、pnpm 和 Node.js——整个项目以 monorepo 形式组织。
在本地运行它需要加密钱包吗?只有在你用到与钱包相关的功能时才需要:钱包/私钥配置列在常见的 .env 设置里,而且这套技术栈自带了面向 Web3 的 Wagmi 和 Viem。
Creator
slymnoyann
Size
64.5 MB
Stars
29.4K
Updated
CommitSep 06
Age
4y
Commits · 90 Days