@jcu/cookbook
Advanced tools
The web UI framework for building responsive, mobile-first web projects with University styling
CookBook, formerly known as the JCU Web Framework, can be integrated with any type of web project you're working on – particularly those that support Bootstrap.
Fully-featured web front-end component library, styled with JCU colours and based on Bootstrap v5, including:
JCU logos and website artwork
Iconography from Material Design Icons (optional)
Font families and CSS for Open Sans and Playfair Display (optional)
Dedicated and automated CDN hosting of all resources, including fonts and iconography
Automated npm releases
CookBook is, in essence, a themed version of Bootstrap and can be used as such, like so:
Web and HTML:
React:
react-bootstrapcookbook-react library which contains custom components
which are already themed (Coming Soon)JCU CookBook resources can be included in your project from JCU's official CDN in a similar manner to that of Bootstrap's CDN. Insert the following code into your project:
<!-- In the <head> of your project -->
<link rel="stylesheet" href="https://cdn.jcu.edu.au/cookbook/3.2/css/cookbook.min.css">
<link rel="stylesheet" href="https://cdn.jcu.edu.au/cookbook/3.2/css/fonts.min.css">
<!-- Before the closing </body> tag in your project -->
<script src="https://cdn.jcu.edu.au/cookbook/3.2/js/popper.min.js"></script>
<script src="https://cdn.jcu.edu.au/cookbook/3.2/js/bootstrap.min.js"></script>
Refer to the official User documentation links above for how to build pages using Bootstap.
Images can be used from the CDN like so:
<link rel="icon" href="https://cdn.jcu.edu.au/cookbook/3.2/img/favicon.ico" />
<img src="https://cdn.jcu.edu.au/cookbook/3.2/img/logos/jcu-logo-horizontal.svg" alt="James Cook University (JCU) Australia logo">
Available resources and their corresponding paths can be found by referrring
to the dist/ directory
within this repository. The subpath should be appended after the version
number in the URL, as per the example.
If you'd like to use the optional iconography library, you can add the following into your page or app as well:
<!-- In the <head> of your project -->
<link rel="stylesheet" href="https://cdn.jcu.edu.au/cookbook/3.2/css/materialdesignicons.min.css">
You can now use icons by following the instructions at https://dev.materialdesignicons.com/getting-started/webfont (skipping the setup steps as you've already done them).
Different versions of CookBook are available on the CDN depending on your desired stability and level of control over the resources:
3 – always use the latest release under this major version; or3.2 – always use the latest release under this minor version; or3.2.2 – A specific version number; orlatest (Not Recommended) – always use the latest release, including
major versions that may have backwards incompatible changes; ormaster (Not Recommended) - the most recent commit's build on the master
branch; which are useful for developmentSo, for example, if you wanted to always use the latest version of CookBook, and are okay with major version changes, use the following format of URL:
<link rel="stylesheet" href="https://cdn.jcu.edu.au/cookbook/latest/css/cookbook.min.css">
For other verisons, replace latest with your desired major, minor or patch
version. Note that you must keep all versions of resources in sync across all
HTML tags to ensure things function correctly.
If you are using a NodeJS-based project there is also published package on npm
under @jcu/cookbook:
@jcu/cookbook: this tag will install the latest version
and needs to be explicitly upgraded to future versions@jcu/cookbook@latest: this tag is equivalent to the latest version on
the CDN@jcu/cookbook@dev: this tag is the equivalent to the master version on
the CDNTo upgrade your project to use a more recent version of CookBook, simply change its version in your HTML. If you are moving to a new major version, you should refer to the CookBook Changelog for details of changes. For minor or patch releases, you should do the same but given our use of SemVer, changes will be feature releases or bug fixes.
Builds utilise the same style of package scripts defined in package.json
that Bootstrap does, with some additional steps and changes for the inclusions
in this package. At a high level, however, the process looks like so:
The resulting distribution is then published to the CDN and documentation published accordingly online (coming shortly).
Install this package and its dependencies with:
yarn
Execute a build with:
yarn dist
Test the resulting build.
At present, this involves manual testing with the HTML documentation and checking against in-development applications.
To obtain public URLs to test with, create a release to the test CDN environment:
yarn dist
yarn release-cdn-test
To automatically create an in-development package that's available on npm,
include the magic string [npm publish] within your commit message. Note
that this doesn't affect the publishing of packages for tags; these occur
automatically on creating and pushing a tagged release.
Ensure the Github Repository has the following environment secrets:
CDN_URL: base URL used for retrieving published version details (such
as https://cdn.jcu.edu.au/cookbook)
NPM_TOKEN: Automation token for publishing npm packages automatically
(see npm's documentation on Creating and viewing access
tokens)
S3-compatible storage access credentials used by
s3-sync-action:
AWS_S3_BUCKET: name of the bucket to sync toAWS_ACCESS_KEY_ID: AWS Access KeyAWS_SECRET_ACCESS_KEY: AWS Secret Access KeyGiven the types of changes that have occurred since the last release, decide on the new version based upon SemVer rules.
With the new version number known, update the following:
CHANGELOG.md: current release version, date and tag URLREADME.md: CDN URLssrc/scss/cookbook.scss: version messagesite/docs/index.js: version variableFor major or minor version releases, also change the following:
package.json: version numberssite/docs/index.html: version navbar entries, header, URLs & footerCommit and create a release tag (e.g. v99.0.1)
git commit -m "chore: release v99.0.1"
git tag v99.0.1
Update the working version number in the source code:
yarn release-version [current-version eg 99.0.1] [development-version eg 99.0.2]
When using yarn release-version, ensure you omit any v prefix for
version numbers.
Check and commit the changes that were made. Care will need to be taken in the case where CookBook's version change conflicts with another, hence a patch commit is suggested:
git add -p .
git commit -m "Back to development"
Additionally, if releasing a new major or minor version, package.json
will need to be updated to reflect this.
Push the results:
git push
git push --tags
This will automatically execute the release workflow which will upload the generated distribution to the CDN and release a corresponding package to npm, checking the success of these outputs in the process.
Firstly, follow the instructions above for Building this project.
Set up an Rclone environment with rclone config and create a remote
called jcu-cdn-cookbook. Ask a maintainer if you're unsure what the
configuration should contain.
Build a release and copy the distribution to CDN via:
yarn release
Update CHANGELOG.md and CDN URLs inside README.md with the current date
and released version
Commit the build to Git and tag accordingly:
git commit CHANGELOG.md README.md dist/ -m "Release v9.9.9"
git tag v9.9.9
Publish to npm via the following:
yarn publish
Don't set a New version at this time; just hit enter/return. We'll
update it ourselves in a moment.
Update the working version number in the source code:
yarn release-version [old-version eg 2.0.0] [new-version eg 2.0.1]
git commit -a -m "Back to development"
When using yarn release-version, ensure you omit any v prefix for
version numbers.
Push the results:
git push
git push --tags
Upgrading dependencies – including Bootstrap – takes place via:
yarn upgrade-interactive
where you can inspect the recent changes and assess the impact of the dependency changes on the project. In general, minor or patch version changes should be fine to apply, provided everyone is following SemVer.
When it comes to Bootstrap itself, pay close attention to the release notes and the official blog for details of changes. As with other dependencies, the same SemVer rules apply but carefully check the resulting theme when built as regressions are always possible.
Once you've upgraded, inspect the documentation site to ensure styles and functionality is working as expected. We'll have more automated processes for this in the near future.
Documentation provided in this project primarily comes from the upstream Bootstrap project. In terms of updating the docs, it is a case of pulling down a new or updated version and manually editing the HTML. The following commands can assist with automating some of this progress:
# Homepage
mv site/docs/index.html site/docs/index.prev.html
wget https://getbootstrap.com/ -O site/docs/index.html
# Cheatsheet
mv site/docs/cheatsheet.html site/docs/cheatsheet.prev.html
wget https://getbootstrap.com/docs/5.1/examples/cheatsheet/ -O site/docs/cheatsheet.html
wget https://getbootstrap.com/docs/5.1/examples/cheatsheet/cheatsheet.css -O site/docs/cheatsheet.css
wget https://getbootstrap.com/docs/5.1/examples/cheatsheet/cheatsheet.js -O site/docs/cheatsheet.js
# Point Cheatsheet links at official docs
sed -i 's#\(/docs/5.1/\)#https://getbootstrap.com\1#g' site/docs/cheatsheet.html
# Improve layout of Cheatsheet headers
sed -i 's/pt-3 pt-xl-5 pb-2 pb-xl-3/pt-1 pt-xl-2 pb-1 pb-xl-2/g' site/docs/cheatsheet.html
From here, it's a case of manually ascertaining what to remove (certain meta tags, GTM JavaScript, ads, specific images and so on), what to reword or restyle (much of it on the homepage, the CSS on the cheatsheet) and what to add in (JCU header and footer).
JCU CookBook aims to allow websites and applications that that use it to be compliant with WCAG 2.1 Level AA. As a component library, it is possible for system implementers and developers to mix and match components, add styles and integrate with applications in ways that may not meet WCAG requirements. One such example is using light text or button classes on top of a light background; the helper classes exist, but to enable a developer to create an accessible environment. In short, we strive to provide the toolkit that web systems can use to be fully accessible, but it is the responsibility of each application to test themselves.
Contributions are always welcome to improve accessibilty within this project and the core components it provides.
JCU Brand DNA v2.7 (retrieved 2020-07-31), adapted like so:
JCU website (accessed 2020-07-31)
Institutional logos (retrieved in .zip archive form, converted into
web-compatible SVG format and colours set to match the JCU website logo)
0 (zero) and YEARS shapes
removed from vectorised files (except small vertical/shield variants)See https://www.pmc.gov.au/government/australian-national-symbols/australian-flags for details. Reproduction of the following resources is underst
Australian Aboriginal Flag: https://en.wikipedia.org/wiki/File:Australian_Aboriginal_Flag.svg (Public domain in USA; educational use in Australia)
Torres Straight Islanders Flag: https://en.wikipedia.org/wiki/File:Flag_of_the_Torres_Strait_Islanders.svg (Non-free media; education use in Australia)
Use of JCU CookBook and its resources are limited to James Cook University projects and where appropriate permission is sought to use the branding. Specific aspects of the JCU CookBook, such as logos and artwork, may be subject to their own approvals, copyright or licensing and users are advised to seek their own independent advice regarding their usage from the appropriate University departments.
[3.2.2] - 2021-09-15
imagemin-cli to v6 (and thus imagemin to v7) to prevent
mangling of State of the Tropics SVG image.FAQs
The web UI framework for building responsive, mobile-first web projects with University styling
The npm package @jcu/cookbook receives a total of 0 weekly downloads. As such, @jcu/cookbook popularity was classified as not popular.
We found that @jcu/cookbook demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 3 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
MITRE's 2024 CWE Top 25 highlights critical software vulnerabilities like XSS, SQL Injection, and CSRF, reflecting shifts due to a refined ranking methodology.
Security News
In this segment of the Risky Business podcast, Feross Aboukhadijeh and Patrick Gray discuss the challenges of tracking malware discovered in open source softare.
Research
Security News
A threat actor's playbook for exploiting the npm ecosystem was exposed on the dark web, detailing how to build a blockchain-powered botnet.