Openbridge Web Components

This monorepo contains the OpenBridge design system implemented as web components.

🚀 Project Status

v1.0.0 is now released! It has been an incredibly productive first year, with more than 200 components already implemented. The code was officially opened by Prince Sverre Magnus of Norway and is now publicly available, marking our first stable milestone.

🌿 Branching Strategy

We use two main branches to manage our development:

• develop: This is the active development branch. It contains the latest changes and features. Note that this branch may include breaking changes and is intended for contributors and early adopters. Releases based on this branch are tagged as next on npm.
• stable: This branch contains the stable, production-ready version of the library. It is updated from the develop branch approximately once every quarter. Releases based on this branch are tagged as latest on npm.

🤝 Support the Project

We are thrilled if you would like to support the OpenBridge Web Components project. Your contribution plays a vital role in maintaining an open, high-quality design system.

We invite industry partners to join our Joint Industry Project. By becoming a donor, you help secure the future of the project and gain influence over the roadmap.

Donor Benefits

By becoming a donor, you aren’t just supporting code—you’re joining a collaborative movement. To show our appreciation, donors receive a specialized benefits package valid for 12 months upon receipt of payment:

• Proudly Show Your Support: You are authorized to use the official "OpenBridge Member" logo in your marketing materials and corporate communications.
• Early & Easy Access: You gain the right to use all new releases of the project’s software components directly under the Apache License 2.0.

How to Support

If you are interested in supporting the project, please fill out this Support Form.

For more information, please contact Torstein A. Bø at [email protected] or contact us on Slack.

📜 Licensing Model

We will always remain open source, but we have evolved our model to ensure continued development. With the 1.0.0 release, we have transitioned to a new licensing system.

How it works:

Under the new model, each release, both based on develop and stable branch, follows a "delayed" permissive license cycle:

1. Initial Release: Each new version is licensed under AGPL for the first 6 months.
2. Transition: After 6 months, the license for that specific version automatically switches to Apache 2.0.
3. Supporter Access: Project donors and sponsors receive immediate access to the code under the Apache 2.0 license.

Example: If version 1.2.2 is released on August 14, 2026:

• open-source projects and internal users can use it immediately under AGPL.
• donors can use it immediately under Apache 2.0.
• From February 14, 2027, version 1.2.2 becomes available to everyone under the Apache 2.0 license (e.g., for commercial use without AGPL restrictions).

💬 Slack

Join our Slack to get the latest updates and to ask questions.

🎬 Introduction video

We have made a short introduction to the library.

📂 Monorepo Structure

This repository uses npm workspaces and is organized as follows:

📚 Storybook & Demo

• Storybook: Browse components, view states, and interact with them in isolation.
• Live Demo: See the components in action within a Vue.js application.

🚩 Getting Started Development

To get started with developing the components:

With VS Code Dev Container (Recommended ✅)

1. Clone the repository.
2. Open in VS Code.
3. Run Dev Container: Open Workspace in Container and select openbridge-webcomponents.code-workspace.
4. Once running, go to packages/openbridge-webcomponents and run npm run storybook.

Manual Setup (Not Recommended ⚠️)

1. Clone the repository.
2. Install Node.js (v20+).
3. Run npm install in the root folder.
4. Run npm run build:lib to build all libraries.

For more detailed development instructions, see IMPLEMENTATION_GUIDELINES.md, AGENTS.md and CONTRIBUTING.md.

👫 Contributing

We welcome contributions! Please see CONTRIBUTING.md for branch naming, commit conventions, and PR guidelines.

📄 Documentation Index