UCF Header

Header universitas

Kunjungi https://universityheader.ucf.edu untuk instruksi dan pedoman penggunaan. Instruksi di bawah ini untuk bekerja dengan kode sumber header.

---

Instalasi

1. Kloning repositori ini dan letakkan di lokasi yang dapat diakses web.
2. Jika ini adalah instalasi pertama kali, salin config.templ.conf , perbarui nilai konfigurasi yang diperlukan untuk lingkungan Anda, dan simpan sebagai config.conf .
3. cd ke src/ Subdirektori, dan jalankan ./compile.sh
4. Load index.html (di direktori root repo) di browser Anda; Pastikan semua aset dimuat dengan benar.
5. Ulangi langkah 3 setelah semua penyebaran berikutnya.

Perkembangan

Persyaratan

• Node v16+
• Tegp-cli

Instruksi

1. Ikuti semua langkah instalasi yang diuraikan di atas.

2. Jika Anda ingin mengaktifkan BrowserSync untuk pengembangan lokal, atau membuat perubahan lain pada konfigurasi Gulp default proyek ini, salin gulp-config.template.json , buat perubahan yang diinginkan, dan simpan sebagai gulp-config.json .

   Untuk mengaktifkan BrowserSync, atur sync ke true dan sesuaikan nilai syncTarget Anda yang diperlukan untuk pengaturan host lokal Anda.

   Daftar lengkap nilai konfigurasi yang dapat dimodifikasi dapat dilihat di gulpfile.js (lihat variabel config ).

3. Buat perubahan seperti yang diinginkan untuk file di src/scss/ atau ke src/js/bar.js . Aset gambar harus ditambahkan/disesuaikan sesuai kebutuhan langsung di bar/img/ .

   Jangan membuat perubahan pada src/js/university-header.js , src/js/university-header-full.js , atau file di bar/css/ Langsung.

4. Jalankan gulp default untuk memproses aset. Tugas ini juga akan menjalankan src/compile.sh untuk kenyamanan.

5. Jalankan gulp watch untuk terus menonton perubahan pada file SCSS dan JS. Jika Anda mengaktifkan browsersync di gulp-config.json , itu juga akan memuat ulang browser Anda ketika file SCSS atau JS berubah. gulp watch juga akan menjalankan src/compile.sh untuk kenyamanan.

6. Tinjau perubahan Anda terhadap index.html .

Instruksi CI

1. Atur variabel lingkungan yang ditemukan di file config.templ.conf . Untuk alur kerja GitHub, ini dapat ditambahkan sebagai variabel repositori, dan kemudian ditambahkan ke variabel env dari alur kerja.
2. prebuild dan build skrip perlu dijalankan untuk membangun proyek. Ini tergantung dan dapat dijalankan secara seri, npm run prebuild && npm run build .
3. Output build akan menulis ke bar/ direktori. Ini adalah direktori yang dapat digunakan.

Berkontribusi

Ingin mengirimkan laporan bug atau permintaan fitur? Lihatlah pedoman yang berkontribusi kami untuk informasi lebih lanjut. Kami ingin mendengar dari Anda!