# explorer This repository contains the **new** 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/. ## 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. 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 ``` ### 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 TBD ## Preview Two deployments are executed on each PR or push to `main`: - [Stage environment](https://vocdoni-explorer-stg.netlify.app/) - [Dev environment](https://vocdoni-explorer-dev.netlify.app/) Also, for now, the `main` branch is deploying a custom deploy accessible via https://dev.explorer.vote ## 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][]. ## License This repository is licensed under the [GNU Affero General Public License v3.0.](./LICENSE) Vocdoni Explorer 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) [SDK]: https://developer.vocdoni.io/sdk [development guidelines]: https://developer.vocdoni.io/development-guidelines