Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/eea/volto-forests-theme
Volto FISE theme components
https://github.com/eea/volto-forests-theme
Last synced: 3 months ago
JSON representation
Volto FISE theme components
- Host: GitHub
- URL: https://github.com/eea/volto-forests-theme
- Owner: eea
- License: mit
- Archived: true
- Created: 2021-07-22T10:51:11.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2024-03-27T13:20:51.000Z (7 months ago)
- Last Synced: 2024-07-21T10:23:09.339Z (4 months ago)
- Language: JavaScript
- Size: 3.13 MB
- Stars: 0
- Watchers: 27
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
- awesome-volto - volto-forests-theme - Volto theme for "Forest Information System For Europe" (Addons / Themes)
README
# volto-forests-theme
[](https://github.com/eea/volto-forests-theme/releases)
[](https://ci.eionet.europa.eu/view/Github/job/volto-addons/job/volto-forests-theme/job/master/display/redirect)
[](https://sonarqube.eea.europa.eu/dashboard?id=volto-forests-theme-master)
[](https://sonarqube.eea.europa.eu/dashboard?id=volto-forests-theme-master)
[](https://sonarqube.eea.europa.eu/dashboard?id=volto-forests-theme-master)
[](https://sonarqube.eea.europa.eu/dashboard?id=volto-forests-theme-master)
[](https://ci.eionet.europa.eu/view/Github/job/volto-addons/job/volto-forests-theme/job/develop/display/redirect)
[](https://sonarqube.eea.europa.eu/dashboard?id=volto-forests-theme-develop)
[](https://sonarqube.eea.europa.eu/dashboard?id=volto-forests-theme-develop)
[](https://sonarqube.eea.europa.eu/dashboard?id=volto-forests-theme-develop)
[](https://sonarqube.eea.europa.eu/dashboard?id=volto-forests-theme-develop)
[Volto](https://github.com/plone/volto) add-on
## Features
## Getting started
### Try volto-forests-theme with Docker
1. Get the latest Docker images
```
docker pull plone
docker pull plone/volto
```
1. Start Plone backend
```
docker run -d --name plone -p 8080:8080 -e SITE=Plone -e PROFILES="profile-plone.restapi:blocks" plone
```
1. Start Volto frontend
```
docker run -it --rm -p 3000:3000 --link plone -e ADDONS="@eeacms/volto-forests-theme" plone/volto
```
1. Go to http://localhost:3000
### Add volto-forests-theme to your Volto project
1. Make sure you have a [Plone backend](https://plone.org/download) up-and-running at http://localhost:8080/Plone
1. Start Volto frontend
- If you already have a volto project, just update `package.json`:
```JSON
"addons": [
"@eeacms/volto-forests-theme"
],
"dependencies": {
"@eeacms/volto-forests-theme": "^0.1.0"
}
```
- If not, create one:
```
npm install -g yo @plone/generator-volto
yo @plone/volto my-volto-project --addon @eeacms/volto-forests-theme
cd my-volto-project
```
1. Install new add-ons and restart Volto:
```
yarn
yarn start
```
1. Go to http://localhost:3000
1. Happy editing!
## Release
### Automatic release using Jenkins
* 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.
* It runs on every commit on `master` branch, which is protected from direct commits, only allowing pull request merge commits.
* 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.
* Automated release scripts are located in the `eeacms/gitflow` docker image, specifically [js-release.sh](https://github.com/eea/eea.docker.gitflow/blob/master/src/js-release.sh) script. It uses the `release-it` tool.
* 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.
* The version format must be MAJOR.MINOR.PATCH. By default, next release is set to next minor version (with patch 0).
* 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.
* Automated commits and commits with [JENKINS] or [YARN] in the commit log are excluded from `CHANGELOG.md` file.
### Manual release from the develop branch ( beta release )
#### Installation and configuration of release-it
You need to first install the [release-it](https://github.com/release-it/release-it) client.
```
npm install -g release-it
```
Release-it uses the configuration written in the [`.release-it.json`](./.release-it.json) file located in the root of the repository.
Release-it is a tool that automates 4 important steps in the release process:
1. Version increase in `package.json` ( increased from the current version in `package.json`)
2. `CHANGELOG.md` automatic generation from commit messages ( grouped by releases )
3. GitHub release on the commit with the changelog and package.json modification on the develop branch
4. NPM release ( by default it's disabled, but can be enabled in the configuration file )
To configure the authentification, you need to export GITHUB_TOKEN for [GitHub](https://github.com/settings/tokens)
```
export GITHUB_TOKEN=XXX-XXXXXXXXXXXXXXXXXXXXXX
```
To configure npm, you can use the `npm login` command or use a configuration file with a TOKEN :
```
echo "//registry.npmjs.org/:_authToken=YYYYYYYYYYYYYYYYYYYYYYYYYYYYYY" > .npmrc
```
#### Using release-it tool
There are 3 yarn scripts that can be run to do the release
##### yarn release-beta
Automatically calculates and presents 3 beta versions - patch, minor and major for you to choose ( or Other for manual input).
```
? Select increment (next version):
❯ prepatch (0.1.1-beta.0)
preminor (0.2.0-beta.0)
premajor (1.0.0-beta.0)
Other, please specify...
```
##### yarn release-major-beta
Same as `yarn release-beta`, but with premajor version pre-selected.
##### yarn release
Generic command, does not automatically add the `beta` to version, but you can still manually write it if you choose Other.
#### Important notes
> 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.
> 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).
## How to contribute
See [DEVELOP.md](https://github.com/eea/volto-forests-theme/blob/master/DEVELOP.md).
## Copyright and license
The Initial Owner of the Original Code is European Environment Agency (EEA).
All Rights Reserved.
See [LICENSE.md](https://github.com/eea/volto-forests-theme/blob/master/LICENSE.md) for details.
## Funding
[European Environment Agency (EU)](http://eea.europa.eu)