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/目錄。這是可以部署的目錄。

貢獻

想要提交錯誤報告或功能請求嗎？查看我們的貢獻指南以獲取更多信息。我們很想收到您的來信！