https://github.com/Teradata/covalent

Teradata UI Platform built on Angular Material
https://github.com/Teradata/covalent

angular angular-material angular2 material material-design teradata typescript

Last synced: about 2 months ago
JSON representation

Teradata UI Platform built on Angular Material

• Host: GitHub
• URL: https://github.com/Teradata/covalent
• Owner: Teradata
• License: mit
• Created: 2016-07-11T23:30:52.000Z (over 8 years ago)
• Default Branch: main
• Last Pushed: 2024-10-17T20:16:17.000Z (2 months ago)
• Last Synced: 2024-10-18T11:03:08.841Z (2 months ago)
• Topics: angular, angular-material, angular2, material, material-design, teradata, typescript
• Language: TypeScript
• Homepage: https://teradata.github.io/covalent/
• Size: 146 MB
• Stars: 2,228
• Watchers: 107
• Forks: 358
• Open Issues: 86
• Metadata Files:
  • Readme: README.md
  • Contributing: docs/CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md
  • Security: SECURITY.md

Awesome Lists containing this project

• awesome - Teradata/covalent - Teradata UI Platform built on Angular Material (TypeScript)

README

        
## Covalent Design System

[![Covalent CI](https://github.com/teradata/covalent/actions/workflows/ci.yml/badge.svg)](https://github.com/teradata/covalent/actions/workflows/ci.yml)

[![npm](https://img.shields.io/npm/v/%40covalent/core.svg)](https://www.npmjs.com/package/@covalent/core)

[![npm](https://img.shields.io/npm/v/%40covalent/core/next.svg)](https://www.npmjs.com/package/@covalent/core/v/next)

[![Join the chat at https://gitter.im/Teradata/covalent](https://badges.gitter.im/Teradata/covalent.svg)](https://gitter.im/Teradata/covalent?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)

[![npm](https://img.shields.io/npm/l/@covalent/core.svg)](LICENSE)



Covalent is Teradata's design system used to create Teradata branded experiences. This space is intended to be used to support developers creating coded experiences for Teradata products. Currently we are only supporting angular and a library of web components.

**Vision: To build an atomic, reusable component platform for Teradata to consume, while collaborating in an open source model.**

## Setup

- Ensure you have Node 18.12.0+

- Install Node packages `npm ci`

- Run local build `npm run start`

---

- [Getting Started](docs/GETTING_STARTED.md)

- [Contributing Guidelines](docs/CONTRIBUTING.md)

- [Developer Guide](docs/DEVELOPER_GUIDE.md)

- [Upgrading](docs/UPGRADE.md)

- [Releasing](docs/RELEASE.md)

- [Changelog](docs/CHANGELOG.md)

- [StackBlitz Template](https://stackblitz.com/edit/covalent)

- [Plunker Template](http://plnkr.co/edit/XhSrUWBw2RhCkXPoE4fn)

---

## Angular Support

Certain covalent version are meant for certain angular versions, and here is the matrix:

| Covalent |      Angular      |

| :------: | :---------------: |

|   2.X    |        8.X        |

|   3.X    | 9.X / 10.X / 11.x |

|   4.X    |    12.X / 13.X    |

|   5.X    |       14.X        |

|   6.X    |       15.X        |

|   7.X    |       16.X        |

|   8.X    |       17.X        |

## Browser Support

Covalent is built on a CSS Flexbox layout and all layouts and components heavily rely up that support, so the current browsers are supported in order or recommendation:

#### Current version - 1 for the following:

|               | Chrome | Firefox | Safari | Edge | Mobile Chrome | Mobile Safari |

| ------------- | :----: | :-----: | :----: | :--: | :-----------: | :-----------: |

| **Supported** |   ✓    |    ✓    |   ✓    |  ✓   |       ~       |       ~       |

~ Indicates limited testing & lower priority

## Running Chromatic

`npx chromatic --project-token=${CHROMATIC_PROJECT_TOKEN}`