Erste Schritte

Willkommen bei JudaicaLink! Dieser Leitfaden hilft Ihnen, die Dokumentationsumgebung einzurichten und mit der Erkundung sowie der Mitarbeit am JudaicaLink-Projekt und seinen Teilprojekten zu beginnen.

Voraussetzungen

Bevor Sie beginnen, stellen Sie sicher, dass Sie Folgendes installiert haben:

• Python 3.8 oder neuer

• pip (Python-Paketmanager)

• Virtuelle Umgebung (optional, aber empfohlen)

• Git (zum Klonen des Repositorys)

• Docker (falls containerisierte Bereitstellungen verwendet werden)

Lokale Einrichtung

Folgen Sie diesen Schritten, um die verschiedenen Projekte lokal einzurichten:

JudaicaLink Dokumentation

1. Repository klonen

git clone https://github.com/judaicalink/judaicalink-docs.git
cd judaicalink-docs

2. Virtuelle Umgebung erstellen und aktivieren (empfohlen)

python -m venv venv
source venv/bin/activate  # On macOS/Linux
venv\Scripts\activate  # On Windows

3. Abhängigkeiten installieren

pip install -r requirements.txt

4. Dokumentation lokal erstellen

cd docs
make html  # On Linux/macOS
# or
make.bat html  # On Windows


The generated HTML files will be located in `docs/_build/html/`. Open `index.html` in a browser to view the documentation.

JudaicaLink Labs

1. Repository klonen

git clone https://github.com/judaicalink/judaicalink-labs.git
cd judaicalink-labs

2. Abhängigkeiten installieren

pip install -r requirements.txt

3. Entwicklungsserver starten

python manage.py runserver

JudaicaLink Webseite

1. Repository klonen

git clone https://github.com/judaicalink/judaicalink-site.git
cd judaicalink-site

2. Hugo installieren (falls nicht bereits installiert)

brew install hugo  # On macOS
sudo apt install hugo  # On Linux

3. Webseite erstellen und bereitstellen

hugo server

JudaicaLink Pubby

1. Repository klonen

git clone https://github.com/lod-pubby/pubby-django.git
cd pubby-django

2. Abhängigkeiten installieren

pip install -r requirements.txt

3. Entwicklungsserver starten

python manage.py runserver

Docker für lokale Bereitstellung verwenden

Für eine Full-Stack-Bereitstellung aller Projekte zusammen Docker verwenden:

1. Repository klonen

git clone https://github.com/judaicalink/docker.git
cd docker

2. Umgebung einrichten

cp .env.example .env

3. Container erstellen und starten

docker-compose up --build -d

Read the Docs verwenden

Die JudaicaLink-Dokumentation wird auf Read the Docs gehostet. Sie können die neueste Version online unter folgender Adresse einsehen:

📖 JudaicaLink Dokumentation

Dokumentation aktualisieren

Um Aktualisierungen an der Dokumentation beizutragen:

1. Machen Sie Änderungen an den .rst-Dateien im docs/-Verzeichnis.

2. Dokumentation lokal erstellen

make html

3. Vorschau der Änderungen lokal durch Öffnen von _build/html/index.html in einem Browser.

4. Änderungen committen und pushen:

git add .
git commit -m "Updated documentation"
git push origin main

Nächste Schritte

• Lesen Sie den Benutzerhandbuch für weitere Informationen zur Verwendung von JudaicaLink.

• Überprüfen Sie das Entwicklerhandbuch für Informationen zur Beitrag von Code.

• Besuchen Sie die FAQ, wenn Sie auf Probleme stoßen.