Files
voteathon/README.md
Chiali bac1727fe1 Update README.md
add flow
2023-06-16 15:04:34 -04:00

59 lines
1.6 KiB
Markdown
Raw Permalink Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
# voteathon
## Built for hackers by the hackers.
![github cover](https://github.com/NicoSerranoP/voteathon/assets/16527634/338b93f1-7cd3-44e0-8771-aef726bbcf94)
A private voting app to decide your favorite hackathon project
Want to express your opinion without breaking your introvert bubble? We've got you covered with voteathon, your trusty sidekick in the bustling hackathon arena.
voteathon is the app that transforms the voting process into a super cool, ultra-private, and engaging experience! Say goodbye to the old-fashioned way of voting and embrace the future with this application.
Our secret sauce? The cutting-edge UniRep protocol! No, it's not a spell from a fantasy novel, but it's just as magical. It ensures complete anonymity while maintaining the highest level of security. Your vote counts, but your identity remains hidden giving you the freedom to cast your vote in total privacy.
### If you are seasonal hacker who go one hackathon to the other, this is great for you! Because you could earn reputations along all the hackathon you have won!
----------------------------
Build your own and get started.
# Start the app locally
### 1 Build the files
```shell
yarn build
```
### 2 Start a node
```shell
yarn contracts hardhat node
```
### 3 Deploy smart contracts
in new terminal window, from root:
```shell
yarn contracts deploy
```
### 4 Start a relayer (backend)
```shell
yarn relay start
```
### 5 Start a frontend
in new terminal window, from root:
```shell
yarn frontend start
```
## User flow in a nutshell
![userflow](https://github.com/NicoSerranoP/voteathon/assets/16527634/69f24f45-455f-4f69-8ed1-c5f5bb87b265)