UCF Header

Universitätskopf

Besuchen Sie https://universityheader.ucf.edu, um Anweisungen und Richtlinien zu verwenden. Die folgenden Anweisungen finden Sie für die Arbeit mit dem Quellcode des Headers.

---

Installation

1. Klonen Sie dieses Repository und platzieren Sie es an einem Web-zugänglichen Ort.
2. Wenn es sich um eine Erstinstallation handelt, kopieren Sie config.templ.conf , aktualisieren Sie die Konfigurationswerte nach Bedarf für Ihre Umgebung und speichern Sie als config.conf .
3. cd zum src/ Subditionory und run ./compile.sh
4. Laden Sie index.html (in Repos Root -Verzeichnis) in Ihrem Browser; Stellen Sie sicher, dass alle Vermögenswerte korrekt geladen sind.
5. Wiederholen Sie Schritt 3 Nach allen nachfolgenden Bereitstellungen.

Entwicklung

Anforderungen

• Knoten v16+
• Gulp-Cli

Anweisungen

1. Befolgen Sie alle oben beschriebenen Installationsschritte.

2. Wenn Sie BrowserSync für die lokale Entwicklung aktivieren oder andere Änderungen an der Standard-Gulp-Konfiguration dieses Projekts vornehmen möchten, kopieren Sie gulp-config.template.json , nehmen Sie alle gewünschten Änderungen vor und speichern Sie als gulp-config.json .

   Setzen Sie sync von BrowserSync auf true und passen Sie Ihren syncTarget -Wert nach Bedarf für Ihr lokales Host -Setup an.

   Die vollständige Liste der veränderbaren Konfigurationswerte kann in gulpfile.js angezeigt werden (siehe config ).

3. Nehmen Sie Änderungen wie gewünscht vor Dateien in src/scss/ oder an src/js/bar.js vor. Die Bildvermögen sollten nach Bedarf direkt in bar/img/ hinzugefügt/angepasst werden.

   Nehmen Sie keine Änderungen an src/js/university-header.js , src/js/university-header-full.js oder Dateien in bar/css/ direkt vor.

4. Führen Sie gulp default aus, um Vermögenswerte zu verarbeiten. Diese Aufgabe wird auch src/compile.sh aus ausgeführt.

5. Führen Sie gulp watch aus, um Änderungen an SCSS- und JS -Dateien kontinuierlich zu beobachten. Wenn Sie BrowserSync in gulp-config.json aktiviert haben, laden Sie Ihren Browser auch neu, wenn sich SCSS- oder JS-Dateien ändern. gulp watch wird auch src/compile.sh aus ausgeführt.

6. Überprüfen Sie Ihre Änderungen gegen index.html .

CI -Anweisungen

1. Setzen Sie Umgebungsvariablen in der Datei config.templ.conf . Für einen GitHub -Workflow können diese als Repository -Variablen hinzugefügt und dann zur env -Variablen des Workflows hinzugefügt werden.
2. Das prebuild und build -Skripte müssen ausgeführt werden, um das Projekt zu erstellen. Diese sind abhängig und können in Serien npm run prebuild && npm run build werden.
3. Die Ausgabe des Builds schreibt in die bar/ Verzeichnis. Dies ist das Verzeichnis, was bereitgestellt werden kann.

Beitragen

Möchten Sie einen Fehlerbericht oder eine Feature -Anfrage einreichen? Weitere Informationen finden Sie in unseren beitragenden Richtlinien. Wir würden gerne von Ihnen hören!