UCF Header

Tête universitaire

Visitez https://universityheader.ucf.edu pour les instructions et les directives. Les instructions ci-dessous sont pour travailler avec le code source de l'en-tête.

---

Installation

1. Clone ce référentiel et placez-le dans un emplacement accessible au Web.
2. S'il s'agit d'une première installation, copiez config.templ.conf , mettez à jour les valeurs de configuration si nécessaire pour votre environnement et enregistrez en config.conf .
3. cd au src/ sous-répertoire et exécutez ./compile.sh
4. Charge index.html (dans le répertoire racine de Repo) dans votre navigateur; Assurez-vous que tous les actifs sont chargés correctement.
5. Répétez l'étape 3 après tous les déploiements suivants.

Développement

Exigences

• nœud v16 +
• gorgée

Instructions

1. Suivez toutes les étapes d'installation décrites ci-dessus.

2. Si vous souhaitez activer Browsersync pour le développement local, ou apporter d'autres modifications à la configuration de Gulp par défaut de ce projet, copiez gulp-config.template.json , apportez toutes les modifications souhaitées et enregistrez en tant que gulp-config.json .

   Pour activer BrowsSeSync, définissez sync sur true et ajustez votre valeur syncTarget si nécessaire pour la configuration de votre hôte local.

   La liste complète des valeurs de configuration modifiables peut être affichée dans gulpfile.js (voir la variable config ).

3. Apporter des modifications souhaitées dans les fichiers dans src/scss/ ou sur src/js/bar.js Les actifs d'image doivent être ajoutés / ajustés selon les besoins directement dans bar/img/ .

   N'apportez pas de modifications à src/js/university-header.js , src/js/university-header-full.js , ou fichiers dans bar/css/ directement.

4. Exécutez gulp default pour traiter les actifs. Cette tâche exécutera également src/compile.sh pour plus de commodité.

5. Exécutez gulp watch pour regarder en continu les modifications des fichiers SCSS et JS. Si vous avez activé BrowsersSync dans gulp-config.json , il rechargera également votre navigateur lorsque les fichiers SCSS ou JS changent. gulp watch exécutera également src/compile.sh pour plus de commodité.

6. Passez en revue vos modifications contre index.html .

Instructions CI

1. Définir les variables d'environnement trouvées dans le fichier config.templ.conf . Pour un flux de travail GitHub, ceux-ci peuvent être ajoutés sous forme de variables de référentiel, puis ajoutés à la variable env du flux de travail.
2. Les scripts prebuild et build doivent être exécutés pour construire le projet. Ceux-ci sont dépendants et peuvent être exécutés en série, npm run prebuild && npm run build .
3. La sortie de la construction écrira dans la bar/ répertoire. C'est le répertoire est ce qui peut être déployé.

Contributif

Vous souhaitez soumettre un rapport de bogue ou une demande de fonctionnalité? Consultez nos directives contributives pour plus d'informations. Nous serions ravis de vous entendre!