Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Archive 🙂 #262

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Archive 🙂 #262

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
48 changes: 1 addition & 47 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,47 +1 @@
# Vocdoni UI

Frontend for the Vocdoni voting client

## Docker Builds

There are two types of docker images, bootstrap generated and fully static, depending 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 developing 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.

## Docker compose deployment

To deploy using [Docker Compose](https://docs.docker.com/compose) follow the instructions.

### Prerequisites

- GNU/Linux based operating system
- Docker engine (version 19.03 or above) [Installation](https://docs.docker.com/engine/install/#server)
- Docker compose (version 1.24 or above) [Installation](https://docs.docker.com/compose/install)
- A DNS domain

### Environment Variables

Configure the `.env` file with the following variables:

- `VOCDONI_UI_TAG` Docker tag of the image (main, stage, release)
- `VOCDONI_ENVIRONMENT` Enviromnent type (dev, stage, prod)
- `BOOTNODES_URL` URL to fetch the JSON containing nodes information (gateways, etc.)
- `ETH_NETWORK_ID` Ethereum nework ID (xdai, goerli...)
- `DOMAIN` Domain name to be served. Used by Traefik to fetch SSL certificates from Let's Encrypt
- `LE_EMAIL` Email associated to the domain. Used by Traefik to fetch SSL certificates from Let's Encrypt

TBD: Add all remaining variables.

### Deployment

Pull the images

`docker-compose pull`

Deploy all services

`docker-compose up -d`

After a while, the UI should be ready at https://<yourdomain>
# Superseeded by [ui-scaffold](https://github.com/vocdoni/ui-scaffold)