Skip to content

nihonkarateuci/nihonkarateuci.github.io

Repository files navigation

Nihon Karate Club at UCI Website

This repository contains the source code for the website for the Nihon Karate Club at UC Irvine

You may view the production site here.

You may view the testing site here.

To monitor search trends or update sitemaps for the production site, visit https://search.google.com/search-console and login using the club account.

If you have any questions about the website or our club, please email karate@uci.edu

About

Stack

The current version of the website was built using raw HTML, CSS, and JavaScript. The only dependencies are Font Awesome 4.7.0 for the icons and the Titilium Web and Cinzel fonts from Google Fonts.

File Structure

  • *.html - The .html files making the core of the website
  • images/ - Images used in the website
  • scripts/ - All the core JavaScript functionality for the website
  • styles/ - All stylesheets used in the app
  • defaults/ - The files initially found in the Sites/ directory on the sftp production server.
  • resources/ - Flyers and other forms to share with users
  • googled2fa35bffa4b298f.html - Verification file for the sitemap submitted to Google
  • robots.txt - Advises web crawlers to avoid subdirectories of the website
  • sitemap.xml - A layout of the website to help Googlebot
  • setup.sh - A very simple script used to update permissions when adding changes to the test environment
  • README.md - You're looking at it right now

Build Guide

Outdated but left for reference. build.py no longer exists

Run python3 build.py to build a folder to deploy to the sftp server

When modifying build.py, consider the following:

Include the following files and directories:

  • *.html
  • images/ - With the exception of ./images/extras/
  • scripts/
  • styles/
  • resources/
  • googled2fa35bffa4b298f.html
  • robots.txt
  • sitemap.xml

Do NOT include the following files and directories when deploying the site:

  • defaults/
  • images/extras
  • setup.sh
  • README.md

Additionally, it would be great if you could minify the CSS and JS files before deploying.

Known Issues

  • Smooth scrolling when clicking the explore buttons is not supported on Safari (mobile or desktop).
  • The flipping bio cards behave strangely on mobile.

Build History

  • v1.0.0: First full deployment of website
  • v1.0.0-beta: The first iteration of the site was deployed

About

Website for the Nihon Karate Club at UCI

Resources

Stars

Watchers

Forks

Packages

No packages published

Contributors 7