Skip to content

Latest commit

 

History

History
139 lines (85 loc) · 5.57 KB

README.md

File metadata and controls

139 lines (85 loc) · 5.57 KB
Raw

Royal Navy Design System

Build & Test Master GitHub release GitHub license lerna Coverage Storybook

Build web applications that meet the Royal Navy service standards.

Visit the Roadmap board to view the high-level objectives for the Royal Navy Design System. To check on issues currently being completed, view our Tactical board instead.

Releases & versioning

All packages are published to the NPM registry and we adhere to semantic versioning.

Supported technologies

The following view layer libraries are currently supported:

  • React

Component usage guidelines

Please refer to Storybook to see interactive examples, code snippets and details on how best to consume each of the components.

Installation & quick start

Installation

To install and save to your project's package.json dependencies, run:

# with npm
npm install @royalnavy/fonts @royalnavy/react-component-library styled-components

# ...or with pnpm
pnpm add @royalnavy/fonts @royalnavy/react-component-library styled-components

Note

styled-components is a required peer dependency and is installed with the above command.

Quick start

Here's a quick example application to get you started:

import React from 'react'
import { createRoot } from 'react-dom/client';
import '@royalnavy/fonts'
import { GlobalStyleProvider, Button } from '@royalnavy/react-component-library'

const rootElement = document.getElementById('root');
const root = createRoot(rootElement);

function App() {
  return (
    <GlobalStyleProvider>
      <Button variant="primary">
        Hello, World!
      </Button>
    </GlobalStyleProvider>
  )
}

root.render(<App />)

Monorepo & package management

Splitting up large codebases into separate independently versioned packages is extremely useful for code sharing. However, making changes across many repositories is messy and difficult to track, and testing across repositories gets complicated really fast.

To solve these (and many other) problems, some projects will organize their codebases into multi-package repositories (sometimes called monorepos).

Each package folder has it's own npm package.json and can act like a stand alone project. Pnpm workspaces detects dependencies that are held within the monorepo and creates a link between them, so you can work on a react component and see instant updates in Storybook.

Manage dependencies for packages like normal, but remember to use pnpm add instead of npm install.

Run locally

You'll need Git and Node.js installed to get this project running.

Note

You will need the active LTS (Long-term support) Node.js version for this project (as specified in .nvmrc).

Fork repository (optional)

If you're an external contributor make sure to fork this project first.

Clone repository

git clone [email protected]:Royal-Navy/design-system.git # or clone your own fork

cd design-system

Using nvm (optional)

If you work across multiple Node.js projects there's a good chance they require different Node.js and npm versions.

To enable this we use nvm (Node Version Manager) to switch between versions easily.

  1. Install nvm
  2. Run nvm install in the project directory (this will use .nvmrc)

Scripts

The top level project contains scripts that are then executed for all packages:

  • lint checks syntax and simple errors in javascript files
  • test runs Jest tests in all the packages
  • build runs the build script in all packages

Git hooks

Git commit hooks trigger linting of all staged files when a change is committed.

Prettier

We have configured a set of Prettier options to enforce consistent code formatting.

Browser support

The Royal Navy Design System currently supports all major evergreen browsers.

Licensing

The Royal-Navy/design-system is licensed under the Apache License 2.0.

Contributing

Read the Contributing Guidelines.

Thanks

We use Chromatic for visual regression testing.