Skip to content

TianzeMYou/eecs370.github.io

 
 

Repository files navigation

EECS 370 Course Site Quick Start

Contributing

To contribute to the EECS 370 website, modify the index.html file and create a PR. A Github Task will run, creating a website preview.

In your PR make sure to have 3 other staff members look over your changes before merging them into the main branch.

You can test locally by navigating to the top directory of the repository and running the following command:

$ python3 -m http.server

Then, use a web browser to navigate to http://localhost:8000/

For style, we are using https://www.html-tidy.org/, please install tidy before you contribute

$ tidy -m -indent --indent-spaces 2 --vertical-space no -wrap 0 --drop-empty-elements no index.html

Fomantic UI

The site uses https://fomantic-ui.com/ to customize the look.

Theme: default To modify the CSS variables go to /semantic/src/themes/default/globals/site.variables If you do this you will need to update the build to generate new CSS files:

npx gulp build

Generally, looking through the docs and applying the correct keyword in the class attribute will be enough.

Updating Specs

We are using Primer Spec to generate specs out of markdown files.

All you need to do to update the specs is edit the markdown file and the config file will automatically generate the html.

To preview the specs locally, follow the Primer Spec instructions for previewing locally.

TODO: these markdown specs were from Winter 2020, so please do a diff between the the specs (a lot of the differences are concerning remote teaching arrangements i.e. 5 submits/day)

Example url of p1 specs: https://eecs370.github.io/projects/p1_spec Look at this handy link for testing locally: https://github.com/eecs485staff/primer-spec/blob/main/docs/USAGE_ADVANCED.md#previewing-locally

Calendar

The home page uses the FullCalendar JS library to render the official staff Google Calendar. It is configured to recolor events based on their title, and displays a popup with the event's title and location.

Each semester, remember to update the Google Calendar id (googleCalendarId) in the JavaScript code at the end of index.html.

If you want to change the colors, modify the recolorCalendarEvent() function in index.html.

If the Google Calendar API key is not working, follow the guide on this page to obtain a new API key: https://fullcalendar.io/docs/google-calendar.

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages

  • JavaScript 55.3%
  • Less 35.9%
  • HTML 8.8%