{"id":13568445,"url":"https://github.com/eea/industry-frontend","last_synced_at":"2025-10-28T12:17:03.865Z","repository":{"id":39969590,"uuid":"247916195","full_name":"eea/industry-frontend","owner":"eea","description":"Plone front-end server for European Industrial Emissions Portal (EIEP).","archived":false,"fork":false,"pushed_at":"2025-04-09T15:28:37.000Z","size":13950,"stargazers_count":4,"open_issues_count":0,"forks_count":1,"subscribers_count":22,"default_branch":"master","last_synced_at":"2025-04-09T16:42:38.546Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://industry.eea.europa.eu","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/eea.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":null,"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":"2020-03-17T08:25:24.000Z","updated_at":"2024-11-19T16:55:31.000Z","dependencies_parsed_at":"2023-02-15T11:46:55.649Z","dependency_job_id":"30e28dcc-132d-4da5-9211-4db7370b435d","html_url":"https://github.com/eea/industry-frontend","commit_stats":null,"previous_names":[],"tags_count":208,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eea%2Findustry-frontend","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eea%2Findustry-frontend/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eea%2Findustry-frontend/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eea%2Findustry-frontend/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/eea","download_url":"https://codeload.github.com/eea/industry-frontend/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248358548,"owners_count":21090401,"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":[],"created_at":"2024-08-01T14:00:26.041Z","updated_at":"2025-10-28T12:17:03.800Z","avatar_url":"https://github.com/eea.png","language":"JavaScript","funding_links":[],"categories":["Websites built with Volto"],"sub_categories":["Open-source websites built with Volto"],"readme":"# Industry: Volto frontend\n\n[![Release](https://img.shields.io/github/v/release/eea/industry-frontend?sort=semver)](https://github.com/eea/industry-frontend/releases)\n[![Pipeline](https://ci.eionet.europa.eu/buildStatus/icon?job=volto%2Findustry-frontend%2Fmaster\u0026subject=master)](https://ci.eionet.europa.eu/view/Github/job/volto/job/industry-frontend/job/master/lastBuild/display/redirect)\n[![Pipeline](https://ci.eionet.europa.eu/buildStatus/icon?job=volto%2Findustry-frontend%2Fdevelop\u0026subject=develop)](https://ci.eionet.europa.eu/view/Github/job/volto/job/industry-frontend/job/develop/lastBuild/display/redirect)\n[![Release pipeline](https://ci.eionet.europa.eu/buildStatus/icon?job=volto%2Findustry-frontend%2F3.25.0\u0026build=last\u0026subject=release%20v3.25.0%20pipeline)](https://ci.eionet.europa.eu/view/Github/job/volto/job/industry-frontend/job/3.25.0/lastBuild/display/redirect/)\n\n\n## Documentation\n\nA training on how to create your own website using Volto is available as part of the Plone training at [https://training.plone.org/5/volto/index.html](https://training.plone.org/5/volto/index.html).\n\n\n## Getting started\n\n1. Install `nvm`\n\n        touch ~/.bash_profile\n        curl -o- https://raw.githubusercontent.com/creationix/nvm/v0.34.0/install.sh | bash\n\n        source ~/.bash_profile\n        nvm version\n\n1. Install latest `NodeJS 12.x`:\n\n        nvm install 12\n        nvm use 12\n        node -v\n        v12.16.2\n\n1. Install `yarn`\n\n        curl -o- -L https://yarnpkg.com/install.sh | bash\n        yarn -v\n\n1. Clone:\n\n        git clone https://github.com/eea/industry-frontend.git\n        cd industry-frontend\n\n1. Install\n\n        yarn build\n\n1. Start backend\n\n        docker-compose up -d\n        docker-compose logs -f backend\n\n1. Start frontend\n\n        yarn start:prod\n\n1. See application at http://localhost:3000\n\n## Try it\n\n1. Install [Docker](https://docs.docker.com/install/)\n1. Install [Docker Compose](https://docs.docker.com/compose/install/)\n1. Start:\n\n        git clone https://github.com/eea/industry-frontend.git\n        cd industry-frontend\n\n        docker-compose pull\n        docker-compose up -d\n\n    optionally change `PORTS` via `.env`:\n\n        FRONTEND=9000 BACKEND=9100 docker-compose up -d\n\n1. See application at http://localhost:4000\n\n## Automated @eeacms dependencies upgrades\n\nAll the addon dependencies that are located in the dependencies section of `package.json` file that belong to @eeacms and have a `MAJOR.MINOR.PATCH` version are automatedly upgraded on the release of a new version of the addon. This upgrade is done directly on the `develop` branch. \n\nExceptions from automated upgrades ( see https://docs.npmjs.com/cli/v8/configuring-npm/package-json#dependencies for dependency configuration examples ) :\n* All github or local paths \n* Any version intervals ( `^version` or `\u003eversion` or `MAJOR.MINOR.x` etc )\n\n## Release\n\n  \n### Automatic release using Jenkins\n\n#### Release flow\n\nThe release flow on Volto projects is split in 2 Jenkins jobs:\n\n* A job that runs on every commit on master and creates a production ready GitHub release and tag with the version from `package.json`\n* A job that runs on every new tag ( including the one created in the first job): \n    * A new Docker image is built and released automatically on [DockerHub](https://hub.docker.com/r/eeacms/ims-frontend) with the release tag.\n    * A new entry is automatically added to [Volto - IMS](https://github.com/eea/eea.rancher.catalog/tree/master/templates/volto-ims) `EEA Rancher Catalog` with the release tag\n    * If the project demo stack is configured in `RANCHER_STACKID`, the demo stack is automatically upgraded to the newly created template version\n    * If the project url is configured in `SONARQUBE_TAG`, all volto addon dependencies will be updated both in SonarQube and their `develop` Jenkinsfile with the project url\n\n#### How to start a Production release\n\n*  The automatic release is started by creating a [Pull Request](../../compare/master...develop) from `develop` to `master`. The pull request status checks correlated to the branch and PR Jenkins jobs need to be processed successfully. 1 review from a github user with rights is mandatory.\n* It runs on every commit on `master` branch, which is protected from direct commits, only allowing pull request merge commits.\n* The automatic release is done by [Jenkins](https://ci.eionet.europa.eu). The status of the release job can be seen both in the `README.md` badges and the green check/red cross/yellow circle near the last commit information. If you click on the icon, you will have the list of checks that were run. The `continuous-integration/jenkins/branch` link goes to the Jenkins job execution webpage.\n* Automated release scripts are located in the `eeacms/gitflow` docker image, specifically [frontend-release.sh](https://github.com/eea/eea.docker.gitflow/blob/master/src/frontend-release.sh) script. It  uses the `release-it` tool.\n* As long as a PR request is open from develop to master, the PR Jenkins job will automatically re-create the CHANGELOG.md and package.json files to be production-ready.\n* The version format must be MAJOR.MINOR.PATCH. By default, next release is set to next minor version (with patch 0).\n* You can manually change the version in `package.json`.  The new version must not be already present in the tags/releases of the repository, otherwise it will be automatically increased by the script. Any changes to the version will trigger a `CHANGELOG.md` re-generation.\n* Automated commits and commits with [JENKINS] or [YARN] in the commit log are excluded from `CHANGELOG.md` file.\n\n\n\u003e The release job that runs on the `master` branch only creates the release in GitHub. The release job that runs on the new tag is the one that does the rest. \n\n\n### Manual release from the develop branch ( beta release )\n\n#### Installation and configuration of release-it\n\nYou need to first install the [release-it](https://github.com/release-it/release-it)  client.\n\n   ```\n   npm install -g release-it\n   ```\n\nRelease-it uses the configuration written in the [`.release-it.json`](./.release-it.json) file located in the root of the repository.\n\nRelease-it is a tool that automates 4 important steps in the release process:\n\n1. Version increase in `package.json` ( increased from the current version in `package.json`)\n2. `CHANGELOG.md` automatic generation from commit messages ( grouped by releases )\n3. GitHub release on the commit with the changelog and package.json modification on the develop branch\n\nTo configure the authentification, you need to export GITHUB_TOKEN for [GitHub](https://github.com/settings/tokens)\n\n   ```\n   export GITHUB_TOKEN=XXX-XXXXXXXXXXXXXXXXXXXXXX\n   ```\n\n To configure npm, you can use the `npm login` command or use a configuration file with a TOKEN :\n\n   ```\n   echo \"//registry.npmjs.org/:_authToken=YYYYYYYYYYYYYYYYYYYYYYYYYYYYYY\" \u003e .npmrc\n   ```\n\n#### Using release-it tool\n\nThere are 3 yarn scripts that can be run to do the release\n\n##### yarn release-beta\n\nAutomatically calculates and presents 3 beta versions - patch, minor and major for you to choose ( or Other for manual input).\n\n```\n? Select increment (next version):\n❯ prepatch (0.1.1-beta.0)\n  preminor (0.2.0-beta.0)\n  premajor (1.0.0-beta.0)\n  Other, please specify...\n```\n\n##### yarn release-major-beta\n\nSame as `yarn release-beta`, but with premajor version pre-selected.\n\n##### yarn release\n\nGeneric command, does not automatically add the `beta` to version, but you can still manually write it if you choose Other.\n\n#### Important notes\n\n\u003e The release can be triggered by creating a new tag in the GitHub repository. It is not recommended to do this, because both the version from `package.json` and the `CHANGELOG.md` files will be desynchronized.\n\n\u003e Do not use release-it tool on master branch, the commit on CHANGELOG.md file and the version increase in the package.json file can't be done without a PULL REQUEST.\n\n\u003e Do not keep Pull Requests from develop to master branches open when you are doing beta releases from the develop branch. As long as a PR to master is open, an automatic script will run on every commit and will update both the version and the changelog to a production-ready state - ( MAJOR.MINOR.PATCH mandatory format for version).\n\n\n## Production\n\nWe use [Docker](https://www.docker.com/), [Rancher](https://rancher.com/) and [Jenkins](https://jenkins.io/) to deploy this application in production.\n\n### Release\n\n* Create a new release of this code via `git tag` command or [Draft new release](https://github.com/eea/industry-frontend/releases/new) on Github.\n  * A new Docker image is built and released automatically on [DockerHub](https://hub.docker.com/r/eeacms/industry-frontend) based on this tag.\n\n### Upgrade\n\n* Within your Rancher environment click on the `Upgrade available` yellow button next to your stack.\n\n* Confirm the upgrade\n\n* Or roll-back if something went wrong and abort the upgrade procedure.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Feea%2Findustry-frontend","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Feea%2Findustry-frontend","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Feea%2Findustry-frontend/lists"}