https://github.com/vocdoni/ui-scaffold
Vocdoni's protocol UI
https://github.com/vocdoni/ui-scaffold
blockchain-voting vocdoni vote vote-application
Last synced: about 1 year ago
JSON representation
Vocdoni's protocol UI
- Host: GitHub
- URL: https://github.com/vocdoni/ui-scaffold
- Owner: vocdoni
- License: agpl-3.0
- Created: 2023-03-06T17:21:21.000Z (over 3 years ago)
- Default Branch: develop
- Last Pushed: 2024-10-29T10:21:55.000Z (over 1 year ago)
- Last Synced: 2024-10-29T11:47:17.908Z (over 1 year ago)
- Topics: blockchain-voting, vocdoni, vote, vote-application
- Language: TypeScript
- Homepage: https://app.vocdoni.io
- Size: 28.5 MB
- Stars: 5
- Watchers: 6
- Forks: 2
- Open Issues: 67
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Vocdoni is the first universally verifiable, censorship-resistant, anonymous, and self-sovereign governance protocol.
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 »
More About Us
Vocdoni Website
|
Web Application
|
Blockchain Explorer
|
MIT Law Publication
|
Contact Us
Key Repositories
Vocdoni Node
|
Vocdoni SDK
|
UI Components
|
Application UI
|
Census3
# ui-scaffold
Vocdoni's UI Scaffold is a React application that uses the [Vocdoni SDK](https://developer.vocdoni.io/sdk) and [UI Components library](https://developer.vocdoni.io/ui-components) to provide a user interface for the Vocdoni voting protocol.
It is built with [Vite](https://vitejs.dev/guide/) and is deployed at https://app.vocdoni.io/.
### Table of Contents
- [Getting Started](#getting-started)
- [Preview](#preview)
- [Contributing](#contributing)
- [License](#license)
## Getting Started
### Environment variables
You can create a `.env.local` file to set your custom environment variables
there, here's a list of variables you can use:
- `VOCDONI_ENVIRONMENT`: the vocdoni environment to be used, either
`dev`, `stg` or `prod` (defaults to `stg`).
- `BASE_URL` is used to specify the public base page during build.
- `BUILD_PATH` Specifies the destination of built files.
- `CUSTOM_ORGANIZATION_DOMAINS` A JSON.stringified object of custom domains mapped to organization ids, to
replace the homepage with their profile page.
You can also start the app by prefixing these vars instead of defining your
custom `.env` file:
```bash
VOCDONI_ENVIRONMENT=dev yarn start
# or an example using many of them...
BUILD_PATH=build/dev BASE_URL=/ui-scaffold/dev VOCDONI_ENVIRONMENT=dev yarn build
```
### Custom domain names
The custom domain names environment variable allows to map custom domains to organization ids, so that the homepage
rendered will be the mapped organization profile.
~~~bash
CUSTOM_ORGANIZATION_DOMAINS='{"deadcorp.com":"0x000000000000000000000000000000000000dead"}' yarn build
~~~
With the example above, accessing the app via the `deadcorp.com` domain would render the profile of the organization
with id `0x000000000000000000000000000000000000dead` as the homepage of the app.
### Available Scripts
In the project directory, you can run:
#### `yarn start`
Runs the app in the development mode.
Open
[http://localhost:5173](http://localhost:5173) to view it in the browser (note
the port may change if already used).
#### `yarn build`
Builds the app for production to the `dist` folder.
It correctly bundles
React in production mode and optimizes the build for the best performance.
#### `yarn translations`
Extracts all i18n strings from the code and puts them in the `i18n/locales` json
files. The best way to work with translations is:
### Branching and deploys
Three branches are linked to deploys:
- `develop`, deployed to [app-dev.vocdoni.io] and [dev.onvote.app], and linked to api-dev.
- `stage`, deployed to [app-stg.vocdoni.io] and [stg.onvote.app], and linked to api-stg.
- `main`, deployed to [app.vocdoni.io] and [onvote.app], and linked to LTS api (formerly prod).
Also, all pushes to develop are deployed three times to netlify (one for [vocdoni app dev][netlify dev],
[another for stage][netlify stg] and also one for [onvote stg][netlify onvote stg]). You can easily access these deploys
on each commit to develop, or directly in pull requests.
The common flow to follow when deploying to `main` is passing through all the
other stages:
branch from develop => merge to develop => merge to stage => merge to main
The only exception should be when fixing specific versions to a deployment, in
such case, a hotfix should be created from the desired branch to be updated:
branch from stage (i.e. h/sdk-0.4.1) => PR to stage
branch from main (i.e. h/sdk-0.5.0) => PR to main
## Preview
The site is deployed using legacy branch at https://app.vocdoni.io/ and https://onvote.app/.
## Contributing
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](https://developer.vocdoni.io/development-guidelines).
## License
This repository is licensed under the [GNU Affero General Public License v3.0.](./LICENSE)
Vocdoni UI Scaffold
Copyright (C) 2024 Vocdoni Association
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/agpl-3.0)
[app-dev.vocdoni.io]: https://app-dev.vocdoni.io
[app-stg.vocdoni.io]: https://app-stg.vocdoni.io
[app.vocdoni.io]: https://app.vocdoni.io
[dev.onvote.app]: https://dev.onvote.app
[stg.onvote.app]: https://stg.onvote.app
[onvote.app]: https://onvote.app
[netlify dev]: https://vocdoni-app-dev.netlify.app/
[netlify stg]: https://vocdoni-app-stg.netlify.app/
[netlify onvote stg]: https://onvote-stg.netlify.app/
[vocdoni logo]: https://docs.vocdoni.io/Logotype.svg
[commit activity badge]: https://img.shields.io/github/commit-activity/m/vocdoni/ui-scaffold
[discord badge]: https://img.shields.io/badge/discord-join%20chat-blue.svg
[github issues badge]: https://img.shields.io/github/issues/vocdoni/ui-scaffold
[twitter badge]: https://img.shields.io/twitter/follow/vocdoni?style=social&label=Follow
[discord invite]: https://discord.gg/xFTh8Np2ga
[twitter follow]: https://twitter.com/intent/user?screen_name=vocdoni
[github issues]: https://github.com/vocdoni/ui-scaffold/issues
[github commits]: https://github.com/vocdoni/ui-scaffold/commits/main
[SDK]: https://developer.vocdoni.io/sdk
[related react packages]: https://github.com/vocdoni/ui-components#vocdonis-ui-components