search

oaknational / oak-components

A React Typescript components library for Oak National Academy Web Applications
https://components.thenational.academy
MIT License
3 stars 0 forks source link
storybook ui-components

readme

Oak National Academy

Oak Components

License: MIT

Overview

This is a React Typescript components library which supports React and Next applications produced by Oak National Academy.

Installation

This library is suitable for use in an app using React 18 and Next.js 13.5+

You can install it using npm i @oaknational/oak-components or any other package manager that supports the NPM registry.

👉 You'll need two environment variables to enable icons NEXT_PUBLIC_OAK_ASSETS_HOST and NEXT_PUBLIC_OAK_ASSETS_PATH. Values for these can be obtained from the .env config from OWA or from a fellow engineer.

Theming, global styles and fonts

For components to be styled correctly they will need access to a theme, some global styles and the Lexend font.

If you're using the Next.js App router your root layout should look something like:

// layout.js
import { OakThemeProvider, oakDefaultTheme, OakGlobalStyle } from "@oaknational/oak-components";
import { Lexend } from "next/font/google";

const lexend = Lexend({ subsets: ['latin'] });

export default function RootLayout({ children }) {
  return (
    <html lang="en">
      <OakGlobalStyle />
      <body className={lexend.className}>
        <OakThemeProvider theme={oakDefaultTheme}>{children}</OakThemeProvider>
      </body>
    </html>
  );
}

To enable SSR of styles and avoid a flicker of unstyled content you'll need to configure your Next.js app to support styled-components

TypeScript

If you're using TypeScript you might want to add @types/styled-components to your development dependencies (npm i -D @types/styled-components). This will ensure that all components are properly type hinted in your IDE.

Development

  1. Copy the example env config cp .env.example .env
  2. Ask a colleague for the values to populate .env
  3. run nvm use
  4. run npm install
  5. To view the storybook run npm run storybook

Making changes

We use conventional commits and semantic versioning. Releases are managed by Semantic Release and are automatically published to NPM on every merge to main.

Changes should go through a pull-request to main and require approval by at least 1 reviewer. You should seek reviews from a QA/designer/PM when necessary.

The release process is driven by the commit messages, following the Conventional Commits standard. The @semantic-release/commit-analyzer plugin will determine the type of release (major, minor, or patch) based on the commit message.

Here’s a summary of the commit types that trigger a release:

Commit messages that begin with chore, refactor or docs, etc. will not trigger the release process.

Testing components inside a host app like OWA

Sometimes it isn't enough to develop entirely inside Storybook and it might be necessary to try local changes inside a target app. You can do this with yalc

  1. Install yalc npm i yalc -g
  2. Run npm run publish:local to add the package to yalc's local registry.
  3. Inside the target app run yalc add @oaknational/oak-components — this will install the package from the local registry like it would from NPM
    • 🚨 if you're an Oak engineer developing in OWA there is a convenience script and you should use npm run use-local-components instead as it will perform some additional work to remove any existing installation of the package.
  4. Now when you start your target app you should have access to the locally packaged version of the library
  5. To uninstall the local package you can run yalc remove @oaknational/oak-components inside the target app
    • 🚨 if you're an Oak engineer developing in OWA there is a convenience script and you should use npm run remove-local-components instead as it will automatically re-install the library from NPM.

Structure

We're trying to follow the tenets of "Atomic design". Brad Frost's book is a great resource if you're just starting out building your first component for this library. It's also a great reference if you're in doubt as to where a component belongs (it can be a little fuzzy at times!).

Components are organised into a three tier hierarchical structure applying the following rules:

Atoms

Molecules

Organisms

External Contributions

Security and Bug Bounty

Please see our security.txt file.

Contributing to the Code

We don't currently accept external contributions to the code base, but this is under review and we hope to find an approach the works for us and the community.

Open Source Acknowledgements

As with all web projects we are dependent on open source libraries maintained by others. While it is not practical to acknowledge them all, we would nevertheless like to express our gratitude for the contributions and efforts of the OSS community. Our dependency list can be found in our package.json file.

License

Unless stated otherwise, the codebase is released under the MIT License. This covers both the codebase and any sample code in the documentation. Where any Oak National Academy trademarks or logos are included, these are not released under the MIT License, and should be used in line with Oak National Academy brand guidelines.

Any documentation included is © Oak National Academy and available under the terms of the Open Government Licence v3.0, except where otherwise stated.