UCF Header

Encabezado de la universidad

Visite https://universityheader.ucf.edu para obtener instrucciones y pautas de uso. Las instrucciones a continuación son para trabajar con el código fuente del encabezado.

---

Instalación

1. Clone este repositorio y colóquelo en una ubicación accesible para la web.
2. Si se trata de una instalación por primera vez, copie config.templ.conf , actualice los valores de configuración según sea necesario para su entorno y guarde como config.conf .
3. cd al src/ subdirectorio, y ejecutar ./compile.sh
4. Cargar index.html (en el directorio raíz de Repo) en su navegador; Asegúrese de que todos los activos estén cargados correctamente.
5. Repita el paso 3 después de todas las implementaciones posteriores.

Desarrollo

Requisitos

• nodo V16+
• cli

Instrucciones

1. Siga todos los pasos de instalación descritos anteriormente.

2. Si desea habilitar BROWSERSYNC para el desarrollo local, o realizar otros cambios en la configuración de GULP predeterminada de este proyecto, copiar gulp-config.template.json , realice cualquier cambio deseado y guarde como gulp-config.json .

   Para habilitar BROWSERSYNC, establezca sync en true y ajuste su valor syncTarget según sea necesario para la configuración local de su host.

   La lista completa de valores de configuración modificables se puede ver en gulpfile.js (ver variable config ).

3. Haga cambios como se desee a los archivos en src/scss/ o a src/js/bar.js . Los activos de imagen deben agregarse/ajustarse según sea necesario directamente en bar/img/ .

   No realice cambios en src/js/university-header.js , src/js/university-header-full.js , o archivos en bar/css/ directamente.

4. Ejecute gulp default para procesar activos. Esta tarea también ejecutará src/compile.sh por conveniencia.

5. Ejecute gulp watch para ver continuamente los cambios en los archivos SCSS y JS. Si habilitó BROWSERSERSYNC en gulp-config.json , también recargará su navegador cuando cambien los archivos SCSS o JS. gulp watch también ejecutará src/compile.sh por conveniencia.

6. Revise sus cambios contra index.html .

Instrucciones de CI

1. Establecer variables de entorno encontradas en el archivo config.templ.conf . Para un flujo de trabajo GitHub, se pueden agregar como variables de repositorio y luego agregar a la variable env del flujo de trabajo.
2. Los scripts prebuild la construcción y build deben ejecutarse para construir el proyecto. Estos dependen y se pueden ejecutar en serie, npm run prebuild && npm run build .
3. La salida de la compilación escribirá en la bar/ directorio. Este es el directorio es lo que se puede implementar.

Que contribuye

¿Desea enviar un informe de error o una solicitud de función? Consulte nuestras pautas de contribución para obtener más información. ¡Nos encantaría saber de ti!