Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cds-snc/gcds-utility
GC Design System Utility is a utility framework for GC Design System. | L'utilitaire de Système de design GC est un cadre utilitaire pour ce système.
https://github.com/cds-snc/gcds-utility
canada design-system government government-canada utility-framework
Last synced: 3 days ago
JSON representation
GC Design System Utility is a utility framework for GC Design System. | L'utilitaire de Système de design GC est un cadre utilitaire pour ce système.
- Host: GitHub
- URL: https://github.com/cds-snc/gcds-utility
- Owner: cds-snc
- License: mit
- Created: 2021-11-18T20:23:04.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-10-21T15:29:20.000Z (25 days ago)
- Last Synced: 2024-10-22T02:25:47.817Z (24 days ago)
- Topics: canada, design-system, government, government-canada, utility-framework
- Language: HTML
- Homepage: https://design-system.alpha.canada.ca/
- Size: 1.44 MB
- Stars: 2
- Watchers: 8
- Forks: 0
- Open Issues: 1
-
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.](#utilitaire-de-système-de-design-gc)
# GC Design System Utility
GC Design System Utility is a utility framework for the GC Design System core. It is based on functional CSS (also called atomic CSS or utility-first CSS) that favors small, single-purpose classes with names based on their visual function. These classes are easy to understand, reusable and can be used together to build complex layouts.
## Documentation
You can find the full documentation for GC Design System Utility on [https://design-system.alpha.canada.ca/](https://design-system.alpha.canada.ca/).
## Installation
### How to install using NPM
- Create a new project or go to the root folder of your existing project.
- Run `npm install @cdssnc/gcds-utility` to install the GC Design System Utility package.
### How to install using CDN
Place the following code in the `` element of your site.
```
```
## Local installation
- Clone the repo `git clone https://github.com/cds-snc/gcds-utility`.
- Run `npm install` to install all Node.js dependencies.
- Run `gulp` to monitor your source files for any changes.
- Run `gulp compile` to compile and minify all CSS files.
## How to contribute
If you are interested in contributing to GC Design System Utility, please read our [contributing guidelines](https://github.com/cds-snc/gcds-utility/blob/main/CONTRIBUTING.md).
## License
Code released under the [MIT License](https://github.com/cds-snc/gcds-utility/blob/main/LICENSE).
# --------------------------------------------------------
# Utilitaire de Système de design GC
L'utilitaire de Système de design GC est un cadre utilitaire pour la base de ce système. Cet utilitaire est fondé sur un code CSS fonctionnel (aussi appelé « atomic CSS » ou encore « utility-first CSS ») qui privilégie de petites classes à but unique nommées selon leur fonction visuelle. Ces classes sont réutilisables et faciles à comprendre. De plus, elles peuvent être combinées pour créer des structures complexes.
## Documentation
Toute la documentation sur l'utilitaire de Système de design GC est accessible à l'adresse [https://systeme-design.alpha.canada.ca/](https://systeme-design.alpha.canada.ca/).
## Installation
### Installation à l'aide de NPM
- Créez un nouveau projet ou naviguez vers le dossier racine de votre projet existant.
- Exécutez `npm install @cdssnc/gcds-utility` pour installer le progiciel de l'utilitaire de Système de design GC.
### Installation à l'aide de CDN
Inscrivez le code suivant dans l'élément `` de votre site Web :
```
```
## Installation locale
- Copiez le référentiel `git clone https://github.com/cds-snc/gcds-utility`.
- Exécutez ensuite `npm install` pour installer toutes les dépendances Node.js.
- Puis, exécutez `gulp` pour surveiller tout changement survenant dans vos fichiers sources.
- Finalement, exécutez `gulp compile` pour compiler et minifier tous les fichiers CSS.
## 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-utility/blob/main/CONTRIBUTING.md).
## Licence
Code publié en vertu de la [licence MIT](https://github.com/cds-snc/gcds-utility/blob/main/LICENSE) (en anglais).