Skip to content

Latest commit

 

History

History
87 lines (54 loc) · 3.24 KB

README.md

File metadata and controls

87 lines (54 loc) · 3.24 KB

License Lifecycle:Experimental

🚀 Government of British Columbia Bootstrap v5 Theme

Demonstrations of the theme

A Bootstrap version 5.3 BC Government look-and-feel featuring:

  • The BC Sans typeface
  • Compatibility with pure Bootstrap markup

The project is a successor to the previous Gov-4.0-Bootstrap-theme Gov-2.0-Bootstrap-Skeleton and mygovbc-bootstrap-theme. We combined the best of all projects and leverage the latest Bootstrap version.

Usage

  • Direct Integration with Minified Files

    You can directly use the minified CSS and JS files in your project. The minified CSS file to link can be found via this path:

    dist/css/bootstrap-theme.min.css

    To ensure dropdowns, tooltips, and popovers function properly, you can import the minified JS file into your project. which can be found via this path:

    dist/js/bootstrap-theme.min.js

    These files can be added to your project's <head> section:

    <head>
...
    <script defer="defer" src="js/bootstrap-theme.min.js"></script>
    <link href="css/bootstrap-theme.min.css" rel="stylesheet">
</head>

  • SCSS To Modify Variables/Themes

    This section describes how to change the theme or remove unneeded CSS

    • Tool Setup

      You'll need the following tools installed on your device:

    • First Install

      After your tools are in place, you should install some packages. In the working directory:

      git clone https://github.com/anjanak13/bootstrap-theme.git
cd bootstrap-theme
npm install

    • Building Dist

      To build the styles, JavaScript and other assets, use:

      npm run build

      Or for continuous building and real-time updates as you make changes:

      npm start

  • Migration Guide From Version 4 to 5

    The CHANGELOG outlines the majority of classes and changes needed for migration, allowing you to easily refer to and perform search and replace where necessary.

    If you need to add or modify utilities, you can consult the official bootstrap migration guide for a comprehensive list of changes.

Extending the Theme

Refer to the official Bootstrap documentation to learn about extending or enhancing this theme.

Tooling and build follow the same steps as SCSS To Modify Variables/Themes section