Files
portal/README.md
Thomas Dedek 27b3ad7fc8 update readme
2019-12-23 14:28:27 +01:00

46 lines
1.1 KiB
Markdown

# Ecogood Portal Page
This <abbr title="Single Page Application">SPA</abbr> shows a list of available web applications of ecogood.
![screenshot](docs/screenshot.png "Screenshot")
## Features
- Multi language
### Technical
- generated static website powered by [Hugo](https://gohugo.io/)
- easily extensible by a YAML definition
- responsive layout
- Respects Privacy and Security by setting CSP and RP
- Apache based basic Authentication included
## Development
A live server can be started as usual with hugo:
hugo server
### Add a new language `$lang`
There is only one content page which contains all languages in the front matter. However hugo requires to have a seperate content document per language. Thus they are simply duplicated by a soft link.
ln -s content/index.en.md content/index.${lang}.md
Within that page the translation has to be added in the front matter.
## Deployment
The build and deploy workflow is provided by the contained shell script `build+deploy.sh`.
**Tasks:**
- clean the output folder
- build the project
- upload to the remote SSH target
```bash
chmod +x build+deploy.sh
./build+deploy.sh
```