https://github.com/pingpad-io/ping
minimalistic decentralized social
https://github.com/pingpad-io/ping
decentralized eth etherium hacktoberfest lens lens-protocol social-network social-platform
Last synced: 6 days ago
JSON representation
minimalistic decentralized social
- Host: GitHub
- URL: https://github.com/pingpad-io/ping
- Owner: pingpad-io
- License: agpl-3.0
- Created: 2023-03-23T12:28:11.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-10-30T04:31:44.000Z (7 months ago)
- Last Synced: 2024-10-30T07:15:33.473Z (6 months ago)
- Topics: decentralized, eth, etherium, hacktoberfest, lens, lens-protocol, social-network, social-platform
- Language: TypeScript
- Homepage: https://pingpad.io
- Size: 4.14 MB
- Stars: 23
- Watchers: 2
- Forks: 5
- Open Issues: 37
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- awesome-lens-protocol - Pingpad - Minimalist microblogging platform. (Projects / Open Source)
README
## Overview
**what?**
[pingpad](https://pingpad.io) 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](https://lens.xyz), media is shared using [ipfs](https://ipfs.io) and backed up on [arweave](https://arweave.org)
## Gallery
## Contributing
Thank you for considering contributing to Pingpad!
First, you need to fork and the repository:
```sh
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`.
```sh
cp .env.example .env
```
#### 2. Install dependencies
Use `npm` to install dependencies.
```bash
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.0/install.sh | bash
```
```bash
nvm install 18
nvm use 18
npm install
```
#### 3. Run the dev server
Finally, you can run the dev server:
```sh
npm run dev
```
and navigate to [http://localhost:3000/home](http://localhost:3000/home)
#### 4. You're awesome!
Now you're all set to start contributing to Pingpad! Next, read **[contributing.md](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](https://biomejs.dev/guides/getting-started/)