Skip to content

Latest commit

 

History

History
74 lines (49 loc) · 2.02 KB

README.md

File metadata and controls

74 lines (49 loc) · 2.02 KB

🚀 B.C. Government Bootstrap v4 Theme

Full pretty documentation and demostrations of the theme

Simply put, a Bootstrap v4 B.C. Government Look-and-Feel featuring:

  • 99% pure bootstrap, i.e., no custom classes
  • NPM, Yarn and Bower package manager integration
  • Sample HTML pages and common components like header and footers for rapid start.

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

Theme Developers

If you find yourself wanting to enhance or fix the theme you'll be interested reading this section on how to setup this source on your local device.

First, we do accept pull requests and will promptly merge fixes or enhancements if they make sense for the rest of the relying applications. Note, you should probably check out our issues and/or raise an issue before doing the pull request.

Tools Setup

You'll need the following tools installed on your device to begin working on the theme:

  • NodeJS 6 or greater with NPM 3 or greater to build
  • Ruby to build the Jekyl docs
  • And obviously Git client and GitHub account

First Install

After your tools are in place, you should clone and install some packages:

git clone [email protected]:bcgov/bootstrap-theme.git
cd bootstrap-theme
npm install
gem install bundler
bundle install

Building Dist

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

npm run build

Or for continous building:

npm run watch

Building Docs

To build the docs (Jekyll), use:

npm run docs-compile

Or for continuous building and serving:

npm run docs-serve

Developer Workflow

In two different shells, run npm run watch and npm run docs-serve.