Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/eea/freshwater-frontend
Volto project for Freshwater
https://github.com/eea/freshwater-frontend
Last synced: 3 months ago
JSON representation
Volto project for Freshwater
- Host: GitHub
- URL: https://github.com/eea/freshwater-frontend
- Owner: eea
- Created: 2021-01-08T13:42:47.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2024-04-12T07:17:10.000Z (7 months ago)
- Last Synced: 2024-04-12T16:58:51.392Z (7 months ago)
- Language: JavaScript
- Size: 42.8 MB
- Stars: 3
- Watchers: 33
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
- awesome-volto - Freshwater Information System for Europe - Volto project for [Freshwater Information System for Europe website](https://water.europa.eu/freshwater) (Websites built with Volto / Open-source websites built with Volto)
README
# WISE Freshwater: Volto Frontend
[](https://github.com/eea/freshwater-frontend/releases)
[](https://ci.eionet.europa.eu/view/Github/job/volto/job/freshwater-frontend/job/master/lastBuild/display/redirect)
[](https://ci.eionet.europa.eu/view/Github/job/volto/job/freshwater-frontend/job/develop/lastBuild/display/redirect)
[](https://ci.eionet.europa.eu/view/Github/job/volto/job/freshwater-frontend/job/1.22.0/lastBuild/display/redirect/)
## Documentation
A 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).
## Getting started
1. Install `nvm`
touch ~/.bash_profile
curl -o- https://raw.githubusercontent.com/creationix/nvm/v0.34.0/install.sh | bash
source ~/.bash_profile
nvm version
1. Install latest `NodeJS 12.x`:
nvm install 12
nvm use 12
node -v
v12.16.2
1. Install `yarn`
curl -o- -L https://yarnpkg.com/install.sh | bash
yarn -v
1. Clone:
$ git clone https://github.com/eea/freshwater-frontend.git
$ cd freshwater-frontend
1. Activate `develop` add-ons
$ yarn develop
1. Install dependencies using Yarn
$ yarn
1. Start frontend in develop mode without the need to build the JS resources
$ yarn start
1. Or start frontend in production mode
$ yarn start:prod
1. See application at http://localhost:3000
## Backend
### Installation:
Plone 5 backend package for the WISE-freshwater: https://github.com/eea/freshwater-backend
1. Install [Docker](https://docs.docker.com/install/)
1. Install [Docker Compose](https://docs.docker.com/compose/install/)
1. Clone (in freshwater-frontend package)
$ cd freshwater-frontend
$ git clone [email protected]:eea/freshwater-backend.git backend
1. Build and run the image
$ docker-compose build
$ docker-compose up -d
### Start the stack:
```shell
$ docker-compose up -d ploneapi
```
### Use the shell container to start Plone:
```shell
$ docker-compose exec ploneapi bash
```
### Inside the Plone container, you can use the instance script to start Zope:
```shell
$ bin/standalone fg
```
## Automated @eeacms dependencies upgrades
All 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 automatically upgraded on the release of a new version of the addon. This upgrade is done directly on the `develop` branch.
Exceptions from automated upgrades ( see https://docs.npmjs.com/cli/v8/configuring-npm/package-json#dependencies for dependency configuration examples ) :
- All github or local paths
- Any version intervals ( `^version` or `>version` or `MAJOR.MINOR.x` etc )
## Release
See [release](https://github.com/eea/ims-frontend/tree/master/RELEASE.md)
## Production
For backend image see https://github.com/eea/eea.docker.plonesaas/tree/freshwater
### Deploy
- Within `Rancher > Catalog > EEA` deploy [Volto - Freshwater](https://github.com/eea/eea.rancher.catalog/tree/master/templates/volto-freshwater)