Overview

pingpad.io is a minimalistic decentralized social platform

Features

• Built on Lens protocol
• Full Markdown support
• Rich embeddings
• Statically generated beauty

Contributing

Thank you for considering contributing to Pingpad!

To contribute you will first need to fork and the repository:

git clone https://github.com/pingpad-io/ping.git && cd ping

After that, follow the steps to run Pingpad on your local machine:

0. Install bun

Check the installation on the bun website and never run foreign scripts without reading them first.

curl -fsSL https://bun.sh/install | bash  # Linux/Mac

powershell -c "irm bun.sh/install.ps1 | iex" # Windows

1. Create a .env file

Copy the provided .env.example file to .env.

cp .env.example .env

2. Install dependencies

Use bun to install dependencies.

bun install

3. Running the dev server

Finally, you can run the dev server:

bun run dev

and navigate to http://localhost:3000/home

4. You're awesome!

Now you're all set to start contributing to Pingpad!

To make a high quality contribution, read contributing.md

5. (extra) Install Biome

Biome is used for formatting and linting in the project, and can be installed in the VSCode extension marketplace or on biome website