Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/unirep/unirep-social

A social media platform built upon Unirep protocol.
https://github.com/unirep/unirep-social

blockchain ethereum smart-contracts social-media solidity

Last synced: 5 days ago
JSON representation

A social media platform built upon Unirep protocol.

Awesome Lists containing this project

README

        


Unirep Social






Github license


Linter eslint


Code style prettier


Circle CI

## 💡 About Unirep Social
**UniRep Social** is a social media that is built upon the [Unirep Protocol](https://github.com/Unirep/Unirep). The users of Unirep Social can publish posts, leave comments anonymously, and also give boost/squash to other users anonymously. User can also prove how much reputation he has when posting/commenting.

## 🔋 Requirements

- Intall [rust](https://www.rust-lang.org/tools/install) and [circom 2](https://docs.circom.io/getting-started/installation/)
- Node.js == 16

## 🛠 Installation

Install and build

```bash
yarn && yarn build
```

## 🌈 Run Unirep Social in local

### 1. Start a blockchain environment

```sh
cd packages/core && npx hardhat node
```

### 2. Deploy Unirep and Unirep Social smart contracts

in new terminal window, from root:

```sh
yarn core deploy
```

### 3 Start a relayer (backend)

Copy the [.env.example](https://github.com/Unirep/Unirep-Social/blob/main/packages/backend/.env.example) file to an `.env` file in `packages/backend`
Then grant permission from [Twitter](https://developer.twitter.com/en/portal/dashboard) and [Github Oauth](https://docs.github.com/en/apps/oauth-apps/building-oauth-apps/creating-an-oauth-app).

in new terminal window, from root, start a backend server by

```sh
yarn backend start
```

### 4. Start a frontend

in new terminal window, from root,

```sh
yarn frontend start
```

It will be running at: http://127.0.0.1:3000/ by default.

## 🎯 Contributing

Contributions are always welcome! Feel free to open any issue or send a pull request.
Go to [CONTRIBUTING.md](./CONTRIBUTING.md) and [CODE_OF_CONDUCT.md](./CODE_OF_CONDUCT.md) to learn about how to contribute to Unirep project!

## 🙌🏻 Join our community
- Discord server:
- Twitter account:
- Telegram group:

## Privacy & Scaling Explorations

This project is supported by [Privacy & Scaling Explorations](https://github.com/privacy-scaling-explorations) in Ethereum Foundation.
See more projects on: https://pse.dev/.