{"id":42105631,"url":"https://github.com/openstax/os-webview","last_synced_at":"2026-03-07T00:16:36.648Z","repository":{"id":3343637,"uuid":"49145909","full_name":"openstax/os-webview","owner":"openstax","description":":books: Front-end web application for the OpenStax web site","archived":false,"fork":false,"pushed_at":"2026-02-26T23:04:14.000Z","size":85382,"stargazers_count":28,"open_issues_count":15,"forks_count":5,"subscribers_count":21,"default_branch":"main","last_synced_at":"2026-02-26T23:29:11.870Z","etag":null,"topics":["javascript"],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/openstax.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2016-01-06T16:09:14.000Z","updated_at":"2026-02-26T23:04:13.000Z","dependencies_parsed_at":"2023-09-22T00:24:35.448Z","dependency_job_id":"b6e89df9-9f1a-4b71-9993-ebe8d5c58a62","html_url":"https://github.com/openstax/os-webview","commit_stats":null,"previous_names":[],"tags_count":279,"template":false,"template_full_name":null,"purl":"pkg:github/openstax/os-webview","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openstax%2Fos-webview","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openstax%2Fos-webview/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openstax%2Fos-webview/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openstax%2Fos-webview/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/openstax","download_url":"https://codeload.github.com/openstax/os-webview/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openstax%2Fos-webview/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":30204114,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-06T19:07:06.838Z","status":"ssl_error","status_checked_at":"2026-03-06T18:57:34.882Z","response_time":250,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["javascript"],"created_at":"2026-01-26T13:14:30.253Z","updated_at":"2026-03-07T00:16:36.561Z","avatar_url":"https://github.com/openstax.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n    \u003ca href=\"https://openstax.org\"\u003e\n        \u003cimg height=\"51\" width=\"251\" src=\"https://cdn.jsdelivr.net/gh/openstax/os-webview@master/src/images/logo.svg\"\u003e\n    \u003c/a\u003e\n\u003c/p\u003e\n\n# OpenStax\n\n[![Build Status](https://github.com/openstax/os-webview/actions/workflows/build.yml/badge.svg)](https://github.com/openstax/os-webview/actions/workflows/build.yml)\n\n## Requirements\n\n* [nvm](https://github.com/creationix/nvm)\n\n## Release process\n\nReleases are based on a GitHub [tag](https://github.com/openstax/os-webview/tags), which is based on\nthe version number of the release. The normal process is:\n\n1. Check out a new branch\n2. Update the version number in package.json\n3. Update dependencies\n4. Commit changes\n5. Create and push a tag\n6. Create a GitHub release\n\n### Detailed Release Steps\n\nSteps are given for command-line Git, but they can also be done in GitHub Desktop.\n\n#### 1. Check out a new branch\n\nCreate a new branch for the release:\n\n```bash\ngit checkout -b release-v2.148.0\n```\n\n#### 2. Update the version number\n\nUpdate the version in `package.json` to the new version number (e.g., `2.148.0`). This is the only\nfile that needs to be updated for versioning. We typically increment the middle number. The right\nnumber increments for hotfixes.\n\n```bash\n# Edit package.json and update the \"version\" field\n```\n\n#### 3. Update dependencies\n\nRun `yarn upgrade` to update the yarn.lock file with the latest compatible dependency versions:\n\n```bash\nyarn upgrade\n```\n\nAfter upgrading, run tests to ensure everything still works:\n\n```bash\n./script/build\n./script/test\n```\n\nIf tests fail, investigate and fix any issues before proceeding.\n\n#### 4. Commit changes\n\nCommit the version bump and any dependency updates:\n\n```bash\ngit add package.json yarn.lock\ngit commit -m \"Release v2.148.0\"\ngit push origin release-v2.148.0\n```\n\n#### 5. Create and push a tag\n\nCreate a tag with the version number (note the `v` prefix):\n\n```bash\ngit tag v2.148.0\ngit push origin v2.148.0\n```\n\nThe tag name should match the format `v{major}.{minor}.{patch}` (e.g., `v2.148.0`).\n\n#### 6. Create a GitHub release\n\nGo to [Releases on GitHub](https://github.com/openstax/os-webview/releases) and click \"Draft a new release\":\n\n1. Select the tag you just created (e.g., `v2.148.0`)\n2. Set the release title to match the tag (e.g., `v2.148.0`)\n3. Add release notes describing the changes\n4. Click \"Publish release\"\n\nWe use the release to document which is the latest published version. Keep it as a pre-release\nuntil it has been deployed to production.\n\n## Installation\n\nAll Mac installation instructions assume you already have [Homebrew](http://brew.sh) installed.\n\n### Install nvm\n\n```bash\n# From https://github.com/creationix/nvm\ncurl -o- https://raw.githubusercontent.com/creationix/nvm/v0.31.1/install.sh | bash\n```\n\n### Install OpenStax Webview\n\n```bash\ngit clone git@github.com:openstax/os-webview.git\ncd os-webview\nscript/setup\n```\n\n## Build and Run the Development Server\n\nTo build the site for development and load it in your default web browser with [BrowserSync](http://www.browsersync.io), simply run:\n\n```bash\n. script/bootstrap\nscript/dev\n```\n\nThat will create a new `dev` directory from which the site is served.  Changes should be made to files in the `src` directory.  Webpack will automatically watch for changes in `src`, perform any compilation and transpilation necessary, and update the result in `dev`.\n\n## Testing\n\nTo run the linters and unit tests locally, enter:\n\n```bash\nscript/build\nscript/test\n```\n\nYou can also just run the linters (`yarn lint`) individually without rebuilding.\nYou can run individual tests by name (`yarn jest layout.test`).\n\nCheck code coverage by loading into your browser `/coverage/index.html` from the\nroot of the git repository.\n\n**Note:** The unit tests require the dev build to be built (in the `dev` directory).\n\n## Build for Production\n\n```bash\n./script/build production\n```\n\nYou 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.\n\n## Configuration\n\nThe API_ORIGIN environment variable can be used to specify which [CMS](https://github.com/openstax/openstax-cms) instance is used by os-webview.\nos-webview settings are loaded from the specified CMS instance's webview-settings API.\nThe default API_ORIGIN for script/dev is https://dev.openstax.org\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopenstax%2Fos-webview","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fopenstax%2Fos-webview","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopenstax%2Fos-webview/lists"}