README.md 1.83 KB
Newer Older
Michael Gisbers's avatar
Michael Gisbers committed
1
## Lugor.de Website
2

Michael Gisbers's avatar
Michael Gisbers committed
3 4
[![pipeline status](https://gitlab.mylinuxtime.de/lugor/lugorde/badges/lugor/pipeline.svg)](https://gitlab.mylinuxtime.de/lugor/lugorde/-/commits/lugor)

5 6 7 8 9 10
This repository contains the website published under https://lugor.de

The whole project is build using Hugo (https://gohugo.io) and the Hugo theme Ananke (https://github.com/budparr/gohugo-theme-ananke).

The master repository can be found on https://gitlab.mylinuxtime.de/lugor/lugorde

Michael Gisbers's avatar
Michael Gisbers committed
11
### Requirements
12 13 14 15 16 17

To build the homepage locally the following tools are needed:

 * git
 * hugo

Michael Gisbers's avatar
Michael Gisbers committed
18
#### Arch Linux
19 20 21

    $ pacman -S git hugo

Michael Gisbers's avatar
Michael Gisbers committed
22
#### Debian
23 24 25

    $ apt install git hugo 

Michael Gisbers's avatar
Michael Gisbers committed
26
### Prepare repository
27 28 29 30 31 32 33 34

After installing them using your distributions package-manager the sources can be checked out:

    $ git clone https://gitlab.mylinuxtime.de/lugor/lugorde.git
    $ cd lugorde
    $ git submodule init
    $ git pull --recurse-submodules

Michael Gisbers's avatar
Michael Gisbers committed
35
### Build website
36 37 38 39 40 41 42 43 44 45 46 47 48

`hugo` can now be used to build the website content based on the sources:

    $ hugo -e production

After first run all pages and images are created and copied to the subfolder `public` and can be used from there.

To use the included webserver add the subcommand `server` to the command line.

    $ hugo -e production server

As long as port `1313` on `localhost` is not in use, `hugo` provides a webserver on that port. Open http://localhost:1313/ to open the website using the webserver. To stop the server use `CTRL+C`.

Michael Gisbers's avatar
Michael Gisbers committed
49
### GitLab integration
50 51 52 53

Users of https://gitlab.mylinuxtime.de may fork the website and create a merge request.

The build pipeline creates after any change in the origin repo a preview which can be accessed by https://lugor.gitlab.mylinuxtime.de/lugorde . Deployment to https://lugor.de is done by a daily schedule at 4 o'clock in the morning. The preview includes articles with dates in future and marked as draft.