All Mac installation instructions assume you already have Homebrew installed.
# From https://github.com/creationix/nvm curl -o- https://raw.githubusercontent.com/creationix/nvm/v0.31.1/install.sh | bash
Install OpenStax Webview
git clone email@example.com:openstax/os-webview.git cd os-webview script/setup
Build and Run the Development Server
To build the site for development and load it in your default web browser with BrowserSync, simply run:
. script/bootstrap script/dev
That will create a new
dev directory from which the site is served. Changes should be made to files in the
src directory. Gulp will automatically watch for changes in
src, perform any compilation and transpilation necessary, and update the result in
You can also run individual tasks. Enter
$(npm bin)/gulp --tasks to see the full list.
To run the linters and unit tests locally, enter:
You can also just run the linters (
$(npm bin)/gulp lint) individually without rebuilding.
Note: The unit tests require the dev build to be built (in the
Build for Production
You must configure your web server to host the files in the
dist directory that gets created. No special configuration is required, although it is highly recommended to serve the site using HTTP/2.
The API_ORIGIN environment variable can be used to specify which CMS instance is used by os-webview. os-webview settings are loaded from the specified CMS instance's webview-settings API. The default API_ORIGIN for script/dev is https://dev.openstax.org
You can upgrade dependencies manually or you can upgrade all of them by running
./script/upgrade && ./script/test.
The version must be updated in each release to help prevent browser caching issues. The version is updated in 3 locations.
- version.js Update the constant.
- index.html Update the version on reference to main.css and bundle.js
- package.json Update the version element