Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ticketmaster/aurora
Shared UI Library for Ticketmaster
https://github.com/ticketmaster/aurora
design-system react styled-components ticketmaster ui-library
Last synced: 3 months ago
JSON representation
Shared UI Library for Ticketmaster
- Host: GitHub
- URL: https://github.com/ticketmaster/aurora
- Owner: ticketmaster
- License: mit
- Created: 2018-04-25T17:21:56.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-01-18T12:04:54.000Z (almost 2 years ago)
- Last Synced: 2024-10-03T21:15:38.232Z (3 months ago)
- Topics: design-system, react, styled-components, ticketmaster, ui-library
- Language: JavaScript
- Homepage: http://design.ticketmaster.com
- Size: 6.2 MB
- Stars: 106
- Watchers: 18
- Forks: 64
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
- awesome - aurora - Shared UI Library for Ticketmaster (JavaScript)
README
@ticketmaster/aurora
Shared UI Library for Ticketmaster
[![Build Status][build-badge]][build]
[![Code Coverage][coverage-badge]][coverage]
[![version][version-badge]][package]
[![MIT License][license-badge]][license]
[![PRs Welcome][prs-badge]][prs]
[![Code of Conduct][coc-badge]][coc]
[![size][size-badge]][unpkg-dist]
[![gzip size][gzip-badge]][unpkg-dist]
[![module formats: cjs][module-formats-badge]][unpkg-dist]
## How to get started:
Aurora relies on the [react](https://www.npmjs.com/package/react),
[prop-types](https://www.npmjs.com/package/prop-types),
[react-transition-group](https://www.npmjs.com/package/react-transition-group),
[classnames](https://www.npmjs.com/package/classnames),
and [styled-components](https://www.npmjs.com/package/styled-components)
peer-dependency packages are already to be installed and set up in your project.
Install Aurora from the npm registry by running the following command in your terminal:
```bash
npm install @ticketmaster/aurora
```
Then import each component you want to use in your app:
```jsx
import React from "react";
import ReactDOM from "react-dom";
import { Button } from "@ticketmaster/aurora";
ReactDOM.render(
Hello, world!,
document.getElementById("root")
);
```
[](https://codesandbox.io/s/430zk16k6w?autoresize=1&hidenavigation=1)
## Running the catalog locally:
In order to run the [catalog](https://code.ticketmaster.com/aurora/) locally, you are required to complete the following steps:
1. Execute `yarn install` at this directory's root.
2. Execute `yarn catalog-start` at this directory's root.
3. Navigate to `http://localhost:4000/` or your host alias's port 4000.
## How to use:
A documentation of each component and living styleguide will be available on the brand site for Ticketmaster.com.
## Other docs:
- [Code of Conduct][coc]
- [Contributing][contributing]
- [Maintaining][maintaining]
## LICENSE:
MIT
[build-badge]: https://app.travis-ci.com/ticketmaster/aurora.svg?branch=master
[build]: https://app.travis-ci.com/ticketmaster/aurora
[coverage-badge]: https://img.shields.io/codecov/c/github/ticketmaster/aurora.svg
[coverage]: https://codecov.io/github/ticketmaster/aurora
[version-badge]: https://img.shields.io/npm/v/@ticketmaster/aurora.svg
[package]: https://www.npmjs.com/package/@ticketmaster/aurora
[license-badge]: https://img.shields.io/npm/l/@ticketmaster/aurora.svg
[license]: https://github.com/ticketmaster/aurora/blob/master/LICENSE
[prs-badge]: https://img.shields.io/badge/PRs-welcome-brightgreen.svg
[prs]: http://makeapullrequest.com
[coc-badge]: https://img.shields.io/badge/code%20of-conduct-ff69b4.svg
[coc]: https://github.com/ticketmaster/aurora/blob/master/other/CODE_OF_CONDUCT.md
[contributing]: https://github.com/ticketmaster/aurora/blob/master/CONTRIBUTING.md
[maintaining]: https://github.com/ticketmaster/aurora/blob/master/other/MAINTAINING.md
[gzip-badge]: http://img.badgesize.io/https://unpkg.com/@ticketmaster/aurora/dist/index.umd.min.js?compression=gzip&label=gzip%20size
[size-badge]: http://img.badgesize.io/https://unpkg.com/@ticketmaster/aurora/dist/index.umd.min.js?label=size
[unpkg-dist]: https://unpkg.com/@ticketmaster/aurora/dist/
[module-formats-badge]: https://img.shields.io/badge/module%20formats-umd%2C%20cjs%2C%20es-green.svg