cds-snc / gcds-components

GC Design System Components is a monorepo managing the web components of the GC Design System. | « GC Design System Components » (Composants de Système de design GC) est un référentiel unique qui gère les composants Web de Système de design GC.

La version française suit.

GC Design System Components

GC Design System Components is a monorepo managing the web components of the GC Design System. Web components are encapsulated, reusable custom elements you can use within your web sites/apps. Along with the gcds-components packages, there are additional packages for React and Angular to ease integration into those popular frameworks.

Tools

We are using Stencil.js to build our web components.

Documentation

You can find the full documentation for GC Design System Components on https://design-system.alpha.canada.ca/.

Local installation

• Clone the repo git clone https://github.com/cds-snc/gcds-components.
• Change into the /packages/web directory.
• Run npm install to install all Node.js dependencies.
• Run npm run build to compile web components.

To test the Angular/React packages locally make sure to link the packages to the web package using npm link.

Compiling all packages

In the root directory, run npm run build. All three packages will be compiled.

Packages

Package	Description	Docs
@cdssnc/gcds-components	GC Design System Components	Docs
@cdssnc/gcds-components-react	GC Design System Components – React	Docs
@cdssnc/gcds-components-angular	GC Design System Components – Angular	Docs

How to contribute

If you are interested in contributing to GC Design System Components, please read our contributing guidelines.

License

Code released under the MIT License.

---

Composants de Système de design GC

« GC Design System Components » (Composants de Système de design GC) est un référentiel unique qui gère les composants Web de Système de design GC. Les composants Web sont des éléments personnalisés, encapsulés et réutilisables pouvant être utilisés dans vos sites et applications Web. En plus des paquets gcds-components, il existe des paquets supplémentaires pour React et Angular qui favorisent l’intégration de ceux-ci dans les infrastructures populaires.

Outils

Nous utilisons Stencil.js pour créer nos composants Web.

Documentation

Toute la documentation sur les composants de Système de design GC est accessible à l’adresse https://systeme-design.alpha.canada.ca/.

Installation locale

• Copiez le référentiel git clone https://github.com/cds-snc/gcds-components.
• Allez dans le répertoire /packages/web.
• Exécutez ensuite npm install pour installer toutes les dépendances Node.js.
• Finalement, exécutez npm run build pour compiler les composants Web.

Pour tester localement les paquets Angular/React, assurez-vous de connecter les paquets au paquet Web en utilisant npm link.

Compilation de tous les paquets

Dans le répertoire racine, exécutez npm run build. Les trois paquets seront alors compilés.

Paquets

Paquet	Description	Docs
@cdssnc/gcds-components	Composants de Système de design GC	Docs
@cdssnc/gcds-components-react	Composants de Système de design GC — React	Docs
@cdssnc/gcds-components-angular	Composants de Système de design GC — Angular	Docs

Apportez votre contribution

Si vous souhaitez contribuer aux unités de style de Système de design GC, veuillez lire nos lignes directrices sur la contribution.

Licence

Code publié en vertu de la licence MIT (en anglais).