Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/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.
https://github.com/cds-snc/gcds-components
canada design-system government government-canada web-components
Last synced: 1 day ago
JSON representation
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.
- Host: GitHub
- URL: https://github.com/cds-snc/gcds-components
- Owner: cds-snc
- License: mit
- Created: 2021-12-02T20:11:47.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2025-01-25T06:16:36.000Z (10 days ago)
- Last Synced: 2025-01-26T11:07:26.056Z (9 days ago)
- Topics: canada, design-system, government, government-canada, web-components
- Language: TypeScript
- Homepage: https://design-system.alpha.canada.ca/
- Size: 42.2 MB
- Stars: 41
- Watchers: 21
- Forks: 15
- Open Issues: 35
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
[La version française suit.](#composants-de-système-de-design-gc)
# 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](https://stenciljs.com/) to build our web components.
## Documentation
You can find the full documentation for GC Design System Components on [https://design-system.alpha.canada.ca/](https://design-system.alpha.canada.ca/).
## Local installation
- Clone the repo `git clone https://github.com/cds-snc/gcds-components`.
- Run `npm install` to install all Node.js dependencies.
- Run `npm run build` to compile all three packages (web components, react and angular).
You can test the Angular and React packages locally as this repository is setup using [`npm workspaces`](https://docs.npmjs.com/cli/v10/using-npm/workspaces). Npm workspaces automatically handles the linking of dependent packages on `npm install` so there is no need to manually use `npm link`.
## Compiling all packages
In the root directory, run `npm run build`. All five packages will be compiled.
## Packages
| Package | Description | Docs |
| ------------------------- | ----------------------------------------------------------------------------------- | ---------------- |
| [@cdssnc/gcds-components](packages/web/) | GC Design System Components | [Docs](packages/web/README.md) |
| [@cdssnc/gcds-components-react](packages/react/) | GC Design System Components – React | [Docs](packages/react/README.md) |
| [@cdssnc/gcds-components-angular](packages/angular/) | GC Design System Components – Angular | [Docs](packages/angular/README.md) |
| [@cdssnc/gcds-components-vue](packages/vue/) | GC Design System Components – Vue | [Docs](packages/vue/README.md) |
| [@cdssnc/gcds-components-react-ssr](packages/react-ssr/) | GC Design System Components – React SSR | [Docs](packages/react-ssr/README.md) |
## How to contribute
If you are interested in contributing to GC Design System Components, please read our [contributing guidelines](https://github.com/cds-snc/gcds-components/blob/main/CONTRIBUTING.md).
## License
Code released under the [MIT License](https://github.com/cds-snc/gcds-components/blob/main/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](https://stenciljs.com/) 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/](https://systeme-design.alpha.canada.ca/).
## Installation locale
- Copiez le référentiel `git clone https://github.com/cds-snc/gcds-components`.
- Exécutez ensuite `npm install` pour installer toutes les dépendances Node.js.
- Finalement, exécutez `npm run build` pour compiler les trois paquets (composants Web, React et Angular).
Vous pouvez tester localement les paquets Angular et React puisque ce référentiel est configuré à l’aide de [`npm workspaces`](https://docs.npmjs.com/cli/v10/using-npm/workspaces). Npm workspaces gère automatiquement la liaison de paquets dépendants à l’exécution de `npm install`, donc nul besoin d’exécuter manuellement `npm link`.
### Compilation de tous les paquets
Dans le répertoire racine, exécutez `npm run build`. Les cinq paquets seront alors compilés.
## Paquets
| Paquet | Description | Docs |
| ------------------------- | ----------------------------------------------------------------------------------- | ---------------- |
| [@cdssnc/gcds-components](packages/web/) | Composants de Système de design GC | [Docs](packages/web/README.md) |
| [@cdssnc/gcds-components-react](packages/react/) | Composants de Système de design GC — React | [Docs](packages/react/README.md) |
| [@cdssnc/gcds-components-angular](packages/angular/) | Composants de Système de design GC — Angular | [Docs](packages/angular/README.md) |
| [@cdssnc/gcds-components-vue](packages/vue/) | Composants de Système de design GC — Vue | [Docs](packages/vue/README.md) |
| [@cdssnc/gcds-components-react-ssr](packages/react-ssr/) | Composants de Système de design GC – React SSR | [Docs](packages/react-ssr/README.md) |
## 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](https://github.com/cds-snc/gcds-components/blob/main/CONTRIBUTING.md).
## Licence
Code publié en vertu de la [licence MIT](https://github.com/cds-snc/gcds-components/blob/main/LICENSE) (en anglais).