HIFIS Software web page

The HIFIS Software web page will be the home for gathering information about the activities and services offered by the HIFIS Software team. This website is built using Jekyll.

Build the project locally

Manually

1. Clone the project locally

   git clone --recursive git@codebase.helmholtz.cloud:hifis/overall/hifis.net.git
   cd hifis.net

2. Install Jekyll.
3. Install dependencies.

   bundle install

4. Install submodules (currently bootstrap, Font-Awesome, jquery, MathJax).

   git submodule update --init --recursive

5. Optionally, on Linux systems install FFmpeg to be used to scale Jumbotron images. On systems with Apt

   apt install ffmpeg

   or on systems with Yum

   yum install ffmpeg

6. Optionally, on Linux systems create scaled variants of Jumbotron images to be used on different devices.

   bash scripts/create_jumbotrons.sh assets/img/jumbotrons/

   Note: Be aware that missing scaled variants of Jumbotron images may cause issues in your local installation when rendering the page in the next step.
7. Build and preview the web page.

   bundle exec jekyll serve --future

8. Add content.

Execute the commands above from the root of your repository.

More information is available in Jekyll's documentation

Using the Makefile

If you are using Linux, you may also use the provided Makefile. After having cloned the repository (Step 1 above), make sure to have Jekyll and ffmpeg installed. Now you can start the local development server by running

make all

Individual steps can also be called:

make install     # install dependencies and update submodule
make jumbotrons  # build the jumbotrons using ffmpeg
make serve       # start the dev server
make clean       # Remove all generated/downloaded files

Using docker compose

To start the development server inside a docker container, first clone the hifis repository including all submodules

git clone --recurse-submodules git@codebase.helmholtz.cloud:hifis/overall/hifis.net.git

Then build the container

docker compose build

Start the development server via:

docker compose up

The page can be accessed via http://localhost:4000

Fetch the latest builds from gitlab

The latest master branch (production) build artifacts can be downloaded using

• https://codebase.helmholtz.cloud/hifis/hifis.net/-/jobs/artifacts/master/download?job=build:production