Our main aim is a trustless voting system where anyone can speak their voice and where everything is auditable.
We are engineering building blocks for a permissionless, private and censorship resistant democracy.
Explore the developer portal »
Vocdoni Website | Web Application | Blockchain Explorer | MIT Law Publication | Contact Us
Vocdoni Node | Vocdoni SDK | UI Components | Application UI | Census3
This repository contains the frontend web application that acts as an 'explorer' for the Vocdoni voting blockchain. This explorer allows you to see elections, organizations, and individual votes, as well as raw blocks on the blockchain. It is a react application available to the public at https://explorer.vote/.
There are two types of docker images: bootstrap generated and fully static. The type of image selected depends on the Dockerfile used:
-
Dockerfile: By default, the image includes all NodeJS dependencies, and generates the static site at bootstrap based on the env vars provided. Hence, the initial run of the image takes few minutes to start since it has to build itself. This image is for testing and/or development purposes. -
Dockerfile.static: This image generates the static site at build time, and serves the content with nginx, so once it's built no parameters can be configured at runtime. It starts instantly as you would expect. This is a final image, to be used in production environments.
To deploy using Docker Compose follow these instructions.
- GNU/Linux based operating system
- Docker engine (version 19.03 or above) Installation
- Docker compose (version 1.24 or above) Installation
- A DNS domain
Configure a .env file with the following variables:
API_URLApi url for the Vocdoni APIVOCDONI_UI_TAGDocker tag of the image (master, stg, release)VOCDONI_ENVIRONMENTEnvironment type (dev, stg, prod)ETH_NETWORK_IDEthereum network ID (xdai, goerli...)DOMAINDomain name to be served. Used by Traefik to fetch SSL certificates from Let's EncryptLE_EMAILEmail associated to the domain. Used by Traefik to fetch SSL certificates from Let's Encrypt
Optional:
COMMIT_SHAGit commit hash to be used as an html tagVERIFY_SINGLE_PAGEUse a single-page layout for the frontendBLOCK_TIMEEstimated time for each Vocdoni blockchain blockPLAZA_URLVocdoni application URL for organization profile linksNODE_ENVIf 'development', deploy the site in development mode. This does not set the vocdoni environmentAPP_TITLEAPP_DESCRIPTIONAPP_TAGS
Pull the images
docker-compose pull
Deploy all services
docker-compose up -d
After a while, the UI should be ready at https://<yourdomain>
Github actions are configured to build the Docker image and push it to the registry. The deployment is done using docker-compose.
The changes pushed to ghcr.io are for the branches master, stg and any starting with release.
The explorer is deployed for multiple environments:
production: https://explorer.vote/stage: https://stg.explorer.vote/development: https://dev.explorer.vote/
While we welcome contributions from the community, we do not track all of our issues on Github and we may not have the resources to onboard developers and review complex pull requests. That being said, there are multiple ways you can get involved with the project.
Please review our development guidelines.
This repository is licensed under the GNU Affero General Public License v3.0.
Vocdoni Explorer UI
Copyright (C) 2021 Aragon Labs AG
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Affero General Public License for more details.
You should have received a copy of the GNU Affero General Public License
along with this program. If not, see <https://www.gnu.org/licenses/>.
