https://github.com/1024pix/pix-ui

Pix-UI is the implementation of Pix design principles and guidelines for its products.
https://github.com/1024pix/pix-ui

design-system hacktoberfest pix

Last synced: about 3 hours ago
JSON representation

Pix-UI is the implementation of Pix design principles and guidelines for its products.

• Host: GitHub
• URL: https://github.com/1024pix/pix-ui
• Owner: 1024pix
• License: mit
• Created: 2020-04-28T08:38:40.000Z (over 4 years ago)
• Default Branch: dev
• Last Pushed: 2024-11-13T16:25:05.000Z (2 days ago)
• Last Synced: 2024-11-13T16:29:54.484Z (2 days ago)
• Topics: design-system, hacktoberfest, pix
• Language: JavaScript
• Homepage: https://ui.pix.fr/
• Size: 43.9 MB
• Stars: 15
• Watchers: 16
• Forks: 2
• Open Issues: 12
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
- [Présentation de Pix-UI](#Pix-UI)

- [Installation de l'addon Pix-UI](#Addon)

- [Développment de Pix-UI](#Developpement)

  - [Lancement de storybook en local](#Storybook)

Pix-UI 

==============================================================================

Pix-UI c'est l'implémentation des principes du design system de Pix. Cela se matérialise par :

- **un addon ember**, permettant l'utilisation composants UI Pix sur des applications ember externes

- **un site statique**, présentant les composants UI Pix : https://1024pix.github.io/pix-ui/

![Capture d'écran du storybook en ligne](./docs/assets/screen-pix-storybook.png)

##### Version du projet : 

* Ember CLI v3.24 or above

* Node 12 or above

## Installation de l'addon Pix-UI 

Pour utiliser les composants sur une application Ember externe, il faut installer l'addon ember Pix-UI avec la commande : 

- `npm install @1024pix/pix-ui@`

##### Quel tag choisir ?

`` doit correspondre au numéro de version à installer. Ce numéro de version correspond à une release.

*Par exemple, on peut remplacer `` par `v0.1.1`.*

Pour voir la liste des tags de Pix-UI, [c'est par ici.](https://github.com/1024pix/pix-ui/tags)

##### Installation par défaut

Il est possible d'installer Pix UI sans `#`, auquel cas ce sera la dernière version qui sera installée. 

Plus d'informations sur les [tags git ici](https://git-scm.com/book/fr/v2/Les-bases-de-Git-%C3%89tiquetage).

## Développement de Pix-UI 

* `git clone https://github.com/1024pix/pix-ui.git`

* `cd pix-ui`

* `npm install`

##### Création d'un composant Pix-UI

* `ember g pix-component `

Plus d'informations sur [la création de composant ici](./docs/create-component.mdx).

##### Lancement de storybook en local 

Pour visualiser les composants créés, il faut lancer storybook :

* `npm run storybook`