Skip to content

Commit

Permalink
Updated README files. Added sample image of the platform. Closes #1 C…
Browse files Browse the repository at this point in the history
…loses #2
  • Loading branch information
vexy committed Nov 9, 2022
1 parent 3e6ebd4 commit 1943a02
Show file tree
Hide file tree
Showing 3 changed files with 27 additions and 74 deletions.
99 changes: 26 additions & 73 deletions README-SR.md
Original file line number Diff line number Diff line change
@@ -1,87 +1,40 @@
# Једноставна платформа за гласање
Овај репо садржи код једноставне _платформе за гласање_ написан у `Solidity`-ју и `JavaScript`-у. Помоћни, једноставни фронтенд је написан у `SvelteKit` фрејмворку.
!["Platform_sample"](/sample.png)

_НАПОМЕНА: **ПРОЈЕКАТ ЈЕ И ДАЉЕ У АКТИВНОМ РАЗВОЈУ**_
Овај репо садржи код једноставне _платформе за гласање_ написан у `Solidity`-ју и `TypeScript`-у. Помоћни, једноставни фронтенд је написан у `SvelteKit` фрејмворку.

По потреби, проверавајте стање [пројекта](https://github.com/vexy/simple_voting/projects/1) и/или пријавите [проблем](https://github.com/vexy/simple_voting/issues).
|Компонента система|Верзија|
|-|-|
|`contracts`|`0.9 test-net`|
|`frontend`|`0.0.8`|

## Основне функционалности
Платформ подржава следеће функционалности:
- Добијање гласачког токена (_тзв. **Minting**_)
- Преглед листе јавних анкета:
- преглед детаља анкете (_тзв. **Browsing**_)
- преглед затворених/не активних анкета (_TBD_)
- пријава неодговарајућих анкета (_тзв. **Reporting**_)
- Учествовање у анкети (одговарање на анкетно питање) (_тзв. **Voting**_)
- Креирање нове анкете (_тзв. **Creating Poll**_)

### Предуслови
За употребу ове платформе потребно је поседовање неког дигиталног новчаника (_digital wallet_) који је подешен за повезивање на локалну мрежу. У овом тренутку, једино је подржан [MetaMask](https://metamask.io/) новчаник.
[![wakatime](https://wakatime.com/badge/github/vexy/simple_voting.svg)](https://wakatime.com/badge/github/vexy/simple_voting?style=for-the-badge)

За потпуну употребу ове платформе, следеће компоненте је потребно инсталирати пре свега:
1. Node/NPM
2. Hardhat NPM library
3. Metamask wallet (and browser extension)
## Основне функционалности
> _НАПОМЕНА: **ПРОЈЕКАТ НИЈЕ КОНАЧАН, НИТИ в. 1.0**_
Најлакши начин за инсталацију `Hardhat`-а (уз подразумевани NPM који је инсталиран) би био:
```
npm install --save-dev hardhat
```
Платформ подржава следеће функционалности:
- Бесплатна регистрација
- Постављање питања
- Одговарање на постављена питања

Такође, инсталирајте следеће библиотеке, у колико саме нису инсталиране:
```
npm install --save-dev @nomiclabs/hardhat-waffle ethereum-waffle chai @nomiclabs/hardhat-ethers ethers
```
По потреби, проверавајте стање [пројекта](https://github.com/vexy/simple_voting/projects/1) и/или пријавите [проблем](https://github.com/vexy/simple_voting/issues).

Унесите следеће у терминал, као потврду да је инсталација неопходних ствари прошла без проблема:
```
npx hardhat compile
```
### Предуслови
За употребу ове платформе потребно је поседовање неког дигиталног новчаника (_digital wallet_) који је подешен за повезивање на блокчејн мрежу. У овом тренутку, једино је подржан [MetaMask](https://metamask.io/) новчаник.

## Постављање на блокчејн мреже (_deployment_)
Постављање се врши преко [Hardhat CLI](https://hardhat.org/) система. Погледајте упутства за инсталацију на самом сајту, у зависности од ваше платформе.

За покретање тестова у локалу, потребно је подесити вашу локалну блокчејн мрежу према подразуеваним параметрима (_ускоро и подршка за Truffle suite_).
За више информација о постављању на глвне мреже, погледајте [`DEPLOYMENTS фајл`](/DEPLOYMENTS.md).

Користите следеће команде за тестирање платформе:
```
# постављање на локалну мрежз
npx hardhat --network localhost scripts/migration.js
npx hardhat test
npx hardhat --network localhost test
```

Погледајте [`/scripts`](/scripts/) фолдер за више информација о тестовима.

# Структура
> Структура контракта је и даље у развоју.
```mermaid
flowchart LR
subgraph wallet
o((address))
end
subgraph contract
name
description
exipry
subgraph options
direction TB
option_1--xoption_2
option_2--xoption_3
option_3
end
end
---

wallet((wallet))-->|interacts|contract
contract-->|deployed on|B(blockchains)
```
<div align="center">
<p>Направљено у Србији, априла 2022 🇷🇸</p>
<a href="https://stackexchange.com/users/215166">
<img src="https://stackexchange.com/users/flair/215166.png?theme=clean" width="208" height="58" alt="profile for Vexy on Stack Exchange, a network of free, community-driven Q&amp;A sites" title="profile for Vexy on Stack Exchange, a network of free, community-driven Q&amp;A sites">
</a>
<p>Copyright (C) 2022 <a href="https://github.com/vexy">Vexy</a>
</div>


---
Направљено у Србији, априла 2022 🇷🇸 | Copyright (C) 2022 [Vexy](https://github.com/vexy)
<a href="https://stackexchange.com/users/215166">
<img src="https://stackexchange.com/users/flair/215166.png?theme=clean" width="208" height="58" alt="profile for Vexy on Stack Exchange, a network of free, community-driven Q&amp;A sites" title="profile for Vexy on Stack Exchange, a network of free, community-driven Q&amp;A sites">
</a><br>
**PGP**: `6302D860 B74CBD34 6482DBA2 518766D0 8213DBC0`
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ This is an example of blockchain based voting platform consisting of following c
|Component|Version|
|-|-|
|`contracts`|`0.9 test-net`|
|`frontend`|`0.0.5`|
|`frontend`|`0.0.8`|

[![wakatime](https://wakatime.com/badge/github/vexy/simple_voting.svg)](https://wakatime.com/badge/github/vexy/simple_voting?style=for-the-badge)

Expand Down
Binary file added sample.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 1943a02

Please sign in to comment.