{"id":19816335,"url":"https://github.com/vocdoni/ui-scaffold","last_synced_at":"2025-05-01T10:32:50.535Z","repository":{"id":196806462,"uuid":"610392217","full_name":"vocdoni/ui-scaffold","owner":"vocdoni","description":"Vocdoni's protocol UI","archived":false,"fork":false,"pushed_at":"2024-10-29T10:21:55.000Z","size":29856,"stargazers_count":5,"open_issues_count":67,"forks_count":2,"subscribers_count":6,"default_branch":"develop","last_synced_at":"2024-10-29T11:47:17.908Z","etag":null,"topics":["blockchain-voting","vocdoni","vote","vote-application"],"latest_commit_sha":null,"homepage":"https://app.vocdoni.io","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"agpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/vocdoni.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-03-06T17:21:21.000Z","updated_at":"2024-10-29T09:42:24.000Z","dependencies_parsed_at":"2023-11-06T11:26:03.608Z","dependency_job_id":"28d06635-0004-4b42-9f5d-5cb9847d78b9","html_url":"https://github.com/vocdoni/ui-scaffold","commit_stats":null,"previous_names":["vocdoni/ui-scaffold"],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vocdoni%2Fui-scaffold","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vocdoni%2Fui-scaffold/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vocdoni%2Fui-scaffold/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vocdoni%2Fui-scaffold/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/vocdoni","download_url":"https://codeload.github.com/vocdoni/ui-scaffold/tar.gz/refs/heads/develop","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":224253480,"owners_count":17280934,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["blockchain-voting","vocdoni","vote","vote-application"],"created_at":"2024-11-12T10:09:13.550Z","updated_at":"2024-11-12T10:09:14.789Z","avatar_url":"https://github.com/vocdoni.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\" width=\"100%\"\u003e\n    \u003cpicture\u003e\n      \u003csource media=\"(prefers-color-scheme: dark)\" srcset=\"https://developer.vocdoni.io/img/vocdoni_logotype_full_blank.svg\" /\u003e\n      \u003csource media=\"(prefers-color-scheme: light)\" srcset=\"https://developer.vocdoni.io/img/vocdoni_logotype_full_white.svg\" /\u003e\n      \u003cimg alt=\"Star History Chart\" src=\"https://developer.vocdoni.io/img/vocdoni_logotype_full_white.svg\" /\u003e\n  \u003c/picture\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\" width=\"100%\"\u003e\n    \u003ca href=\"https://github.com/vocdoni/ui-scaffold/commits/main/\"\u003e\u003cimg src=\"https://img.shields.io/github/commit-activity/m/vocdoni/ui-scaffold\" /\u003e\u003c/a\u003e\n    \u003ca href=\"https://github.com/vocdoni/ui-scaffold/issues\"\u003e\u003cimg src=\"https://img.shields.io/github/issues/vocdoni/ui-scaffold\" /\u003e\u003c/a\u003e\n    \u003ca href=\"https://discord.gg/xFTh8Np2ga\"\u003e\u003cimg src=\"https://img.shields.io/badge/discord-join%20chat-blue.svg\" /\u003e\u003c/a\u003e\n    \u003ca href=\"https://twitter.com/vocdoni\"\u003e\u003cimg src=\"https://img.shields.io/twitter/follow/vocdoni.svg?style=social\u0026label=Follow\" /\u003e\u003c/a\u003e\n\u003c/p\u003e\n\n  \u003cdiv align=\"center\"\u003e\n    Vocdoni is the first universally verifiable, censorship-resistant, anonymous, and self-sovereign governance protocol. \u003cbr /\u003e\n    Our main aim is a trustless voting system where anyone can speak their voice and where everything is auditable. \u003cbr /\u003e\n    We are engineering building blocks for a permissionless, private and censorship resistant democracy.\n    \u003cbr /\u003e\n    \u003ca href=\"https://developer.vocdoni.io/\"\u003e\u003cstrong\u003eExplore the developer portal »\u003c/strong\u003e\u003c/a\u003e\n    \u003cbr /\u003e\n    \u003ch3\u003eMore About Us\u003c/h3\u003e\n    \u003ca href=\"https://vocdoni.io\"\u003eVocdoni Website\u003c/a\u003e\n    |\n    \u003ca href=\"https://vocdoni.app\"\u003eWeb Application\u003c/a\u003e\n    |\n    \u003ca href=\"https://explorer.vote/\"\u003eBlockchain Explorer\u003c/a\u003e\n    |\n    \u003ca href=\"https://law.mit.edu/pub/remotevotingintheageofcryptography/release/1\"\u003eMIT Law Publication\u003c/a\u003e\n    |\n    \u003ca href=\"https://chat.vocdoni.io\"\u003eContact Us\u003c/a\u003e\n    \u003cbr /\u003e\n    \u003ch3\u003eKey Repositories\u003c/h3\u003e\n    \u003ca href=\"https://github.com/vocdoni/vocdoni-node\"\u003eVocdoni Node\u003c/a\u003e\n    |\n    \u003ca href=\"https://github.com/vocdoni/vocdoni-sdk/\"\u003eVocdoni SDK\u003c/a\u003e\n    |\n    \u003ca href=\"https://github.com/vocdoni/ui-components\"\u003eUI Components\u003c/a\u003e\n    |\n    \u003ca href=\"https://github.com/vocdoni/ui-scaffold\"\u003eApplication UI\u003c/a\u003e\n    |\n    \u003ca href=\"https://github.com/vocdoni/census3\"\u003eCensus3\u003c/a\u003e\n  \u003c/div\u003e\n\n# ui-scaffold\n\nVocdoni'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.\nIt is built with [Vite](https://vitejs.dev/guide/) and is deployed at https://app.vocdoni.io/.\n\n### Table of Contents\n- [Getting Started](#getting-started)\n- [Preview](#preview)\n- [Contributing](#contributing)\n- [License](#license)\n\n\n## Getting Started\n\n### Environment variables\n\nYou can create a `.env.local` file to set your custom environment variables\nthere, here's a list of variables you can use:\n\n- `VOCDONI_ENVIRONMENT`: the vocdoni environment to be used, either\n  `dev`, `stg` or `prod` (defaults to `stg`).\n- `BASE_URL` is used to specify the public base page during build.\n- `BUILD_PATH` Specifies the destination of built files.\n- `CUSTOM_ORGANIZATION_DOMAINS` A JSON.stringified object of custom domains mapped to organization ids, to\n  replace the homepage with their profile page.\n\nYou can also start the app by prefixing these vars instead of defining your\ncustom `.env` file:\n\n```bash\nVOCDONI_ENVIRONMENT=dev yarn start\n# or an example using many of them...\nBUILD_PATH=build/dev BASE_URL=/ui-scaffold/dev VOCDONI_ENVIRONMENT=dev yarn build\n```\n\n### Custom domain names\n\nThe custom domain names environment variable allows to map custom domains to organization ids, so that the homepage\nrendered will be the mapped organization profile.\n\n~~~bash\nCUSTOM_ORGANIZATION_DOMAINS='{\"deadcorp.com\":\"0x000000000000000000000000000000000000dead\"}' yarn build\n~~~\n\nWith the example above, accessing the app via the `deadcorp.com` domain would render the profile of the organization\nwith id `0x000000000000000000000000000000000000dead` as the homepage of the app.\n\n### Available Scripts\n\nIn the project directory, you can run:\n\n#### `yarn start`\n\nRuns the app in the development mode.\u003cbr /\u003e Open\n[http://localhost:5173](http://localhost:5173) to view it in the browser (note\nthe port may change if already used).\n\n#### `yarn build`\n\nBuilds the app for production to the `dist` folder.\u003cbr /\u003e It correctly bundles\nReact in production mode and optimizes the build for the best performance.\n\n#### `yarn translations`\n\nExtracts all i18n strings from the code and puts them in the `i18n/locales` json\nfiles. The best way to work with translations is:\n\n### Branching and deploys\n\nThree branches are linked to deploys:\n\n- `develop`, deployed to [app-dev.vocdoni.io] and [dev.onvote.app], and linked to api-dev.\n- `stage`, deployed to [app-stg.vocdoni.io] and [stg.onvote.app], and linked to api-stg.\n- `main`, deployed to [app.vocdoni.io] and [onvote.app], and linked to LTS api (formerly prod).\n\nAlso, all pushes to develop are deployed three times to netlify (one for [vocdoni app dev][netlify dev],\n[another for stage][netlify stg] and also one for [onvote stg][netlify onvote stg]). You can easily access these deploys\non each commit to develop, or directly in pull requests.\n\nThe common flow to follow when deploying to `main` is passing through all the\nother stages:\n\n    branch from develop =\u003e merge to develop =\u003e merge to stage =\u003e merge to main\n\nThe only exception should be when fixing specific versions to a deployment, in\nsuch case, a hotfix should be created from the desired branch to be updated:\n\n    branch from stage (i.e. h/sdk-0.4.1) =\u003e PR to stage\n    branch from main (i.e. h/sdk-0.5.0) =\u003e PR to main\n\n\n## Preview\n\nThe site is deployed using legacy branch at https://app.vocdoni.io/ and https://onvote.app/.\n\n## Contributing\n\nWhile 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.\n\nPlease review our [development guidelines](https://developer.vocdoni.io/development-guidelines).\n\n## License\n\nThis repository is licensed under the [GNU Affero General Public License v3.0.](./LICENSE)\n\n\n    Vocdoni UI Scaffold\n    Copyright (C) 2024 Vocdoni Association\n\n    This program is free software: you can redistribute it and/or modify\n    it under the terms of the GNU Affero General Public License as published by\n    the Free Software Foundation, either version 3 of the License, or\n    (at your option) any later version.\n\n    This program is distributed in the hope that it will be useful,\n    but WITHOUT ANY WARRANTY; without even the implied warranty of\n    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\n    GNU Affero General Public License for more details.\n\n    You should have received a copy of the GNU Affero General Public License\n    along with this program.  If not, see \u003chttps://www.gnu.org/licenses/\u003e.\n\n[![License: AGPL v3](https://img.shields.io/badge/License-AGPL%20v3-blue.svg)](https://www.gnu.org/licenses/agpl-3.0)\n\n\n\n[app-dev.vocdoni.io]: https://app-dev.vocdoni.io\n[app-stg.vocdoni.io]: https://app-stg.vocdoni.io\n[app.vocdoni.io]: https://app.vocdoni.io\n[dev.onvote.app]: https://dev.onvote.app\n[stg.onvote.app]: https://stg.onvote.app\n[onvote.app]: https://onvote.app\n[netlify dev]: https://vocdoni-app-dev.netlify.app/\n[netlify stg]: https://vocdoni-app-stg.netlify.app/\n[netlify onvote stg]: https://onvote-stg.netlify.app/\n\n[vocdoni logo]: https://docs.vocdoni.io/Logotype.svg\n[commit activity badge]: https://img.shields.io/github/commit-activity/m/vocdoni/ui-scaffold\n[discord badge]: https://img.shields.io/badge/discord-join%20chat-blue.svg\n[github issues badge]: https://img.shields.io/github/issues/vocdoni/ui-scaffold\n[twitter badge]: https://img.shields.io/twitter/follow/vocdoni?style=social\u0026label=Follow\n\n[discord invite]: https://discord.gg/xFTh8Np2ga\n[twitter follow]: https://twitter.com/intent/user?screen_name=vocdoni\n[github issues]: https://github.com/vocdoni/ui-scaffold/issues\n[github commits]: https://github.com/vocdoni/ui-scaffold/commits/main\n\n[SDK]: https://developer.vocdoni.io/sdk\n[related react packages]: https://github.com/vocdoni/ui-components#vocdonis-ui-components\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvocdoni%2Fui-scaffold","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvocdoni%2Fui-scaffold","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvocdoni%2Fui-scaffold/lists"}