Unirep Social

UniRep Social is a social media that is built upon the Unirep Protocol. 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 and circom 2
Node.js >=16.14

🛠 Installation

Install and build

yarn & yarn build

1. Start a blockchain environment

cd packages/core && npx hardhat node

in new terminal window, from root:

yarn core deploy --network local

3 Start a relayer (backend)

Copy the .env.example file to an .env file in packages/backend Then grant permission from X (Twitter) Oauth and Github Oauth.

Set the authentication settings as following:

X (Twitter)
App permissions	Read
Type of App	Native App
Callback URL/Redirect URL	`http://127.0.0.1:3001/api/oauth/twitter/callback`

Github
Callback URL/Redirect URL	`http://127.0.0.1:3001/api/oauth/github/callback`

in new terminal window, from root:

yarn backend start

4. Start a frontend

in new terminal window, from root:

yarn frontend start

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

🌈 Lint

Format the code

yarn lint:fix

Check if the code is formatted

yarn lint:check

🎯 Contributing

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