README.md 1.64 KB
Newer Older
Erxleben, Fredo's avatar
Erxleben, Fredo committed
1
2
3
4
5
6
7
8
9
10
# 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

1. Clone the project locally
   ```bash
11
12
   git clone --recursive https://gitlab.hzdr.de/hifis/hifis.net.git
   cd hifis.net
Erxleben, Fredo's avatar
Erxleben, Fredo committed
13
14
15
16
17
18
   ```
2. [Install](https://jekyllrb.com/docs/installation/) Jekyll.
3. Install dependencies.
   ```bash
   bundle install
   ```
Uwe Jandt (DESY, HIFIS)'s avatar
period.    
Uwe Jandt (DESY, HIFIS) committed
19
4. Install submodules (currently `bootstrap`, `Font-Awesome`, `jquery`, `MathJax`).
20
21
22
   ``` bash
   git submodule update --init --recursive
   ```
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
5. Optionally, on _Linux_ systems install `FFmpeg` to be used to scale
   Jumbotron images.
   On systems with `Apt`
   ```bash
   apt install ffmpeg
   ```
   _or_ on systems with `Yum`
   ```bash
   yum install ffmpeg
   ```
6. Optionally, on _Linux_ systems create scaled variants of Jumbotron images to
   be used on different devices.
   ```bash
   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.
Erxleben, Fredo's avatar
Erxleben, Fredo committed
41
42
43
   ```bash
   bundle exec jekyll serve --future
   ```
44
8. Add content.
Erxleben, Fredo's avatar
Erxleben, Fredo committed
45
46
47
48
49
50

Execute the commands above from the root of your repository.

More information is available in Jekyll's
[documentation](https://jekyllrb.com/docs/)

51
## Fetch the latest builds from gitlab
Erxleben, Fredo's avatar
Erxleben, Fredo committed
52

53
54
The latest master branch (production) build artifacts can be downloaded using
* https://gitlab.hzdr.de/hifis/hifis.net/-/jobs/artifacts/master/download?job=build:production