README.md 3.96 KB
Newer Older
1
<a href="https://toolbox-bodensee.de"><img src="https://assets.gitlab-static.net/uploads/-/system/group/avatar/6246985/9744766.png" align="right" hspace="10" vspace="6"></a>
Jonas Otto's avatar
Jonas Otto committed
2

maxbachmann's avatar
maxbachmann committed
3
Webseite der Toolbox Bodensee e.V.
L3D's avatar
L3D committed
4 5
====================================

6
[![Build Status](https://gitlab.com/ToolboxBodensee/webseite/toolbox-webseite/badges/master/pipeline.svg)](https://gitlab.com/ToolboxBodensee/webseite/toolbox-webseite/pipelines)
7
[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)
maxbachmann's avatar
maxbachmann committed
8

maxbachmann's avatar
maxbachmann committed
9
**Entwicklung nur auf [GitLab](https://gitlab.com/ToolboxBodensee/webseite/toolbox-webseite). Auf GitHub befindet sich lediglich ein Mirror**
maxbachmann's avatar
maxbachmann committed
10

maxbachmann's avatar
maxbachmann committed
11
Dies ist der Quellcode zur aktuellen Webseite des Maker- und Hackspace Toolbox Bodensee e.V., die unter [toolbox-bodensee.de](https://toolbox-bodensee.de/) erreichbar ist.
maxbachmann's avatar
maxbachmann committed
12

maxbachmann's avatar
maxbachmann committed
13

14 15
Anforderungen
---------------------------------
haekelhexe's avatar
haekelhexe committed
16
Um an der Webseite mitzuarbeiten, musst du lediglich dieses Git Repoitory runterladen und Lektor installieren.<br/>
17
Dies ist sowohl unter Linux, Windows und Apfel möglich.
maxbachmann's avatar
maxbachmann committed
18

19
Zum Clonen des Git Repository sollte lediglich ``git-lfs`` installiert sein. Die Installation aller weiteren Abhängigkeiten ist mit ``make`` möglich. Alternativ gibt es auch einen Docker Container der alles Erforderliche mitbringt.
L3D's avatar
L3D committed
20

21
### Linux:
haekelhexe's avatar
haekelhexe committed
22
Dein Paketmanager *(zum Beispiel ``apt``)* sollte das Paket git-lfs anbieten. Beispiel:
L3D's avatar
L3D committed
23 24 25
```bash
sudo apt install git-lfs
```
maxbachmann's avatar
maxbachmann committed
26

27
### Mac OSX
maxbachmann's avatar
maxbachmann committed
28
```bash
29
brew install git-lfs
30
```
L3D's avatar
L3D committed
31

32 33
### Windows
Lade den Downloader von [hier](https://github.com/git-lfs/git-lfs/releases) und führe ihn aus.
maxbachmann's avatar
maxbachmann committed
34

35 36
### Weitere Informationen
Weitere Informationen zur Installation von git-lfs gibt es auch hier: [git-lfs.github.com](https://git-lfs.github.com/)
L3D's avatar
L3D committed
37

L3D's avatar
L3D committed
38

39
## Installation
maxbachmann's avatar
maxbachmann committed
40

haekelhexe's avatar
haekelhexe committed
41
Zur Erleichterung der Installation beinhaltet das Projekt eine Makefile. Diese erlaubt es ``Abhängigkeiten zu installieren``(z.B. nodejs), sowie die Webseite mit einem ``Python Module`` oder in einem ``Docker Container`` zu bauen.
Fabian Sabau's avatar
Fabian Sabau committed
42

43
Die Webseite kann beispielsweise folgendermaßen ausgeführt werden:
L3D's avatar
L3D committed
44
```bash
45
# source code lokal abspeichern
46
git clone https://gitlab.com/ToolboxBodensee/webseite/toolbox-webseite.git toolbox-webseite
L3D's avatar
L3D committed
47

48 49
# Wechsel in den zugehörigen Ordner
cd toolbox-webseite
Fabian Sabau's avatar
Fabian Sabau committed
50

51 52
# Installation von Abhängigkeiten
make install
Fabian Sabau's avatar
Fabian Sabau committed
53

54 55
# Starten der Webseite (lässt sich unter 127.0.0.01:5000 aufrufen)
make server
L3D's avatar
L3D committed
56
```
L3D's avatar
L3D committed
57

58 59 60 61 62
## Nutzung mit Translation Memory Systemen (TMS)
Da TMS Systeme Lektor Content Dateien nicht unterstützen müssen diese in ein json Format konvertiert und nach der Übersetzung wieder zurück konvertiert werden. Diese Konvertierung wird durch das Skript `translation.py` vorgenommen und kann folgendermaßen genutzt werden:
```bash
# Wechsel in den zugehörigen Ordner
cd toolbox-webseite
L3D's avatar
L3D committed
63

64 65 66
# Konvertieren in Json Format
python translation.py --json

haekelhexe's avatar
haekelhexe committed
67
# Übersetzen der Dateien in TMS (übersetzte Dateien müssen dem Schema contents+<language_code>.json folgen)
68 69 70 71 72 73

# Rückkonvertierung zu Lektor Content Dateien
python translation.py --lr
```

## Nähere Informationen
74
| **[Grundlagen](https://gitlab.com/ToolboxBodensee/webseite/toolbox-webseite/-/wikis/Grundlagen)**     | **[Installation](https://gitlab.com/ToolboxBodensee/webseite/toolbox-webseite/-/wikis/Installation)**     | **[Beitragen](https://gitlab.com/ToolboxBodensee/webseite/toolbox-webseite/-/wikis/Contribution)**           |
75
|-------------------------------------|-------------------------------|-----------------------------------|
maxbachmann's avatar
maxbachmann committed
76
| [![Grundlagen](https://gitlab.com/ToolboxBodensee/webseite/toolbox-webseite/-/wikis/images/tech-docs.png)](https://gitlab.com/ToolboxBodensee/webseite/toolbox-webseite/-/wikis/Grundlagen) | [![Install](https://gitlab.com/ToolboxBodensee/webseite/toolbox-webseite/-/wikis/images/install.png)](https://gitlab.com/ToolboxBodensee/webseite/toolbox-webseite/-/wikis/Installation) | [![Beitragen](https://gitlab.com/ToolboxBodensee/webseite/toolbox-webseite/-/wikis/images/edit.png)](https://gitlab.com/ToolboxBodensee/webseite/toolbox-webseite/-/wikis/Beitragen) |