https://github.com/royal-navy/design-system-docs

Royal Navy Design System documentation site
https://github.com/royal-navy/design-system-docs

contentful documentation graphql nextjs website

Last synced: 2 months ago
JSON representation

Royal Navy Design System documentation site

• Host: GitHub
• URL: https://github.com/royal-navy/design-system-docs
• Owner: Royal-Navy
• License: apache-2.0
• Created: 2021-02-08T11:46:51.000Z (almost 4 years ago)
• Default Branch: master
• Last Pushed: 2024-04-15T12:54:55.000Z (10 months ago)
• Last Synced: 2024-04-17T05:09:29.914Z (9 months ago)
• Topics: contentful, documentation, graphql, nextjs, website
• Language: TypeScript
• Homepage: https://design-system.navy.digital.mod.uk
• Size: 5.91 MB
• Stars: 5
• Watchers: 4
• Forks: 3
• Open Issues: 58
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE
  • Codeowners: .github/CODEOWNERS
  • Security: SECURITY.md

Awesome Lists containing this project

README

        
# Royal Navy Design System Documentation

Royal Navy Design System documentation site.

## Environment variables

| Name                                | Required | Default value                                         | Description                                       |

| ----------------------------------- | -------- | ----------------------------------------------------- | ------------------------------------------------- |

| NEXT_PUBLIC_CONTENTFUL_SPACE_ID     | Yes      |                                                       | Contentful space ID                               |

| NEXT_PUBLIC_CONTENTFUL_ACCESS_TOKEN | Yes      |                                                       | Contentful content delivery API token             |

| NEXT_PUBLIC_CONTENTFUL_ENVIRONMENT  | No       | master                                                | Custom Contentful environment to use              |

| NEXT_PUBLIC_STORYBOOK_BASE_URL      | No       | `https://storybook.design-system.navy.digital.mod.uk` | Base URL for Storybook; used for embedded stories |

## End to end tests

Tests are dependent on the application running.

### Run all specs

`pnpm run test:e2e`

## Licensing

The Royal Navy Design System documentation site is licensed under the [Apache License 2.0](https://github.com/Royal-Navy/design-system-docs/blob/master/LICENSE).