https://github.com/gravitee-io/gravitee-ui-particles

🪐 Set of UI components and UX rules used in Gravitee.io's consoles.
https://github.com/gravitee-io/gravitee-ui-particles

angular design-system gravitee graviteeio hacktoberfest ui-components

Last synced: 6 days ago
JSON representation

🪐 Set of UI components and UX rules used in Gravitee.io's consoles.

• Host: GitHub
• URL: https://github.com/gravitee-io/gravitee-ui-particles
• Owner: gravitee-io
• License: apache-2.0
• Created: 2021-10-21T12:57:49.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2023-12-12T14:21:35.000Z (10 months ago)
• Last Synced: 2023-12-13T10:45:28.249Z (10 months ago)
• Topics: angular, design-system, gravitee, graviteeio, hacktoberfest, ui-components
• Language: TypeScript
• Homepage: https://particles.gravitee.io/
• Size: 4.37 MB
• Stars: 4
• Watchers: 25
• Forks: 3
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.txt
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

        
# Gravitee UI Particles 

![](./assets/gravitee-ui-particules-logo.png)

[![CircleCI](https://circleci.com/gh/gravitee-io/gravitee-ui-particles/tree/main.svg?style=svg)](https://circleci.com/gh/gravitee-io/gravitee-ui-particles/tree/main)

[![Storybook](https://cdn.jsdelivr.net/gh/storybookjs/brand@main/badge/badge-storybook.svg)](https://particles.gravitee.io/)

## Overview

Gravitee UI Particles centralizes the design system applied to all Gravitee consoles. Based on Angular library.

It currently contains the following packages:

 - `@gravitee/ui-particles-angular`: Disign system for Gravitee.io Console (APIM, AM, Cockpit)

 - `@gravitee/ui-particles-analytic`: Contain analytics tools (Pendo)

 - `@gravitee/ui-policy-studio-angular`: Contain the Policy Studio to share between APIM versions

 - `@gravitee/ui-schematics`: Contain Angular schematics to generate components, services, etc.

### Live Demo

You can see components in action on [Storybook](https://main--6183b02d73381a003a3be1a6.chromatic.com/).

### Usage

To use it in your project just run:

```bash

npm install @gravitee/ui-particles-angular

# or

yarn add @gravitee/ui-particles-angular

```

or any other package you want to use.

## Contributing

You think Gravitee.io is awesome and want to contribute to the project?

- Ensure your dependencies are up-to-date by running `yarn install`

- Start Storybook locally with `yarn storybook`, it will serve it on `http://localhost:9008`

- Edit or create a component and Storybook will be updated automatically

- Do not forget to write documentation for each component

- Have a look on [guidelines](https://github.com/gravitee-io/gravitee-ui-particles/blob/master/CONTRIBUTING.md) that should help you get started.

## Copyright

Copyright (C) 2015 The Gravitee team (http://gravitee.io)

Licensed under the Apache License, Version 2.0 (the "License");

See the [LICENSE](https://github.com/gravitee-io/gravitee-ui-particles/blob/master/LICENSE.txt) file for details.

## Changelog

Refer to the [CHANGELOG](https://github.com/gravitee-io/gravitee-ui-particles/blob/main/ui-particles-angular/CHANGELOG.md) for a complete list of changes.