UCF Header

大学头

请访问https://universityheader.ucf.edu以获取使用说明和准则。下面的说明是用于使用标题的源代码。

---

安装

1. 克隆此存储库，并将其放置在可访问的位置。
2. 如果这是首次安装，请复制config.templ.conf ，根据您的环境必要更新配置值，然后将其保存为config.conf 。
3. cd到src/ subdirectory，并运行./compile.sh
4. 加载index.html （在repo的根目录中）在您的浏览器中；确保所有资产都正确加载。
5. 在所有后续部署后，重复步骤3。

发展

要求

• 节点V16+
• Gulp-Cli

指示

1. 按照上面概述的所有安装步骤。

2. 如果您想启用browsersync进行本地开发，或对该项目的默认Gulp配置进行其他更改，请复制gulp-config.template.json ，进行任何理想的更改，并保存为gulp-config.json 。

   要启用浏览器，请将sync设置为true ，并根据需要的本地主机设置来调整syncTarget值。

   可以在gulpfile.js中查看可修改配置值的完整列表（请参阅config变量）。

3. 根据需要更改src/scss/或src/js/bar.js中的文件。图像资产应直接在bar/img/中直接根据需要添加/调整。

   请勿更改src/js/university-header.js ， src/js/university-header-full.js ，或直接在bar/css/的文件。

4. 运行gulp default流程资产。为了方便起见，此任务还将运行src/compile.sh 。

5. 运行gulp watch不断观看对SCS和JS文件的更改。如果您在gulp-config.json中启用了浏览器，则当SCSS或JS文件更改时，它也会重新加载您的浏览器。为了方便起见， gulp watch还将运行src/compile.sh 。

6. 查看您针对index.html更改。

CI说明

1. 在config.templ.conf文件中找到的环境变量。对于GitHub工作流程，可以将它们添加为存储库变量，然后添加到工作流的env变量中。
2. 需要运行prebuild build脚本以构建项目。这些是依赖性的，可以串联运行， npm run prebuild && npm run build 。
3. 构建的输出将写入bar/目录。这是可以部署的目录。

贡献

想要提交错误报告或功能请求吗？查看我们的贡献指南以获取更多信息。我们很想收到您的来信！