Skip to content

pingpad-io/ping

Repository files navigation

Overview

what?

pingpad is a minimalistic decentralized social platform, made for you and your community.

why?

clarity paves the way for brilliance. pingpad is focusing on clear and efficient solutions.

how?

built on top of lens network, media is shared using ipfs and backed up on arweave

Gallery

Contributing

Thank you for considering contributing to Pingpad!

First, you 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:

1. Create a .env file

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

cp .env.example .env

2. Install dependencies

Use npm to install dependencies.

curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.0/install.sh | bash
nvm install 18
nvm use 18
npm install

3. Run the dev server

Finally, you can run the dev server:

npm run dev

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

4. You're awesome!

Now you're all set to start contributing to Pingpad! Next, read contributing.md

5. (extra) Install Biome

Biome is used for formatting and linting in the project, and can be installed in the Zed/VSCode extensions or on biome website