/ic-design-system

Intelligence Community Design System

Primary LanguageTypeScriptMIT LicenseMIT

Logo of the Intelligence Community Design System

The UK Intelligence Community Design System (ICDS)

MIT License

The Intelligence Community Design System helps the United Kingdom's Intelligence Community (MI6, GCHQ, MI5, and partners) to quickly build powerful capabilities that are accessible and easy to use.

This is a joint project led by MI6, working with GCHQ and MI5.

SIS (MI6), GCHQ and MI5 Logos

This repo holds the website at design.sis.gov.uk, look at the ic-ui-kit repo for the ICDS UI Kit components.

Why we're doing this

We build a lot of stuff that needs to be quick-to-build, usable and always accessible. We build using a lot of different tech, so creating something that can be consistently accessible and usable across different stacks is critical for us.

The Design System is being used to build our powerful, flexible and complex capabilities that help keep the UK safe and prosperous.

📖 Read our story to learn more on why we've created our own design system.

Learning from the best

We track many sources of accessibility expertise, as well as using our internal experts and communities. For example, many of our patterns and components are based on awesome work from the Government Digital Service (GDS) Design System. Where we can, we'll contribute back!

If you think we could improve something, please do raise an issue.

Installing

The UI Kit components are in the ic-ui-kit repo 👉.

If you still want to host a local version of the ic-design-system website, it's straightforward.

// dev mode
npm i --legacy-peer-deps
npm run start

// production build outputs to ./dist
npm run clean
npm run build

We use GitHub Actions and Pages to host the website, which is automatically published from main branch ☁️.

Contributing

We have a couple of resources to help you with contributing.

Security

If you've found a vulnerability, we want to know so that we can fix it. Our security policy tells you how to do this.

Questions about the departments

The team is only able to talk about the projects we've put on GitHub 🕵️. We unfortunately can't talk about the work of our departments 😢.

Visit our websites to learn more about:

License

Unless stated otherwise, the codebase is released under the MIT License. This covers both the codebase and any sample code in the documentation. The documentation is and available under the terms of the Open Government License v3.0.

© Crown copyright 2022