@studyportals/bob

Bob

Bob is our page compositing and lay-out service which helps integrating micro service applications on websites in a structured way. This will allow you to focus purely on your application development and less on how it needs to be be integrated on your website.

Why Exactly?

• Allowing to focus on the actual product implementation not website integration
• Decoupling dependencies, if one microservice does not function the page will still be accessible and functional (minus the "broken" microservice).
• SEO quality assurance (ensuring an indexable DOM)
• Maintain world class website performance (enforce quality standards, less code duplication, etc.)

How to use?

More information on how to use bob

Prerequisites

Setup Yarn >=4

corepack enable && corepack prepare yarn@stable && corepack use yarn@stable

Stakeholders

Code Owners

Every incoming change will be reviewed via the Git "Code Owners" principle by at least one Taskforce Bob member and all the Engineering Leadership members to ensure optimal quality and ownership.

Publishing the package on the GitHub Package Registry

• Ensure you are authenticated to the GitHub Package Registry. This section explains how.
• (OPTIONAL) Run npm version [<newversion> | major | minor | patch | premajor | preminor | prepatch | prerelease] to change update package.json and create the appropriate git tag.
• Run npm publish --otp=${YOUR_2FA_TOKEN}

Documentation

Please take a look at the documentation for more detailed documentation.