https://github.com/stellar/stellar-design-system

Components for Stellar’s design system
https://github.com/stellar/stellar-design-system

Last synced: 7 days ago
JSON representation

Components for Stellar’s design system

• Host: GitHub
• URL: https://github.com/stellar/stellar-design-system
• Owner: stellar
• License: apache-2.0
• Created: 2020-12-08T21:19:41.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2024-09-27T17:47:48.000Z (about 2 months ago)
• Last Synced: 2024-10-13T14:53:55.570Z (about 1 month ago)
• Language: TypeScript
• Homepage:
• Size: 3.04 MB
• Stars: 10
• Watchers: 21
• Forks: 7
• Open Issues: 10
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
# Stellar Design System

Components for Stellar Development Foundation’s design system.

## Usage

Install as a dependency:

```bash

yarn add @stellar/design-system

```

Add the main CSS file to your project (for example, the main index file of your

React project).

```javascript

import "@stellar/design-system/build/styles.min.css";

```

Import Stellar Design System components

```javascript

import { Button, Input } from "@stellar/design-system";

```

Available components can be found

[here](./@stellar/design-system/src/components).

## Development

This repo has two parts to it:

- [Stellar Design System repo](./@stellar/design-system/) - everything for the

  design system,

- [Stellar Design System website repo](./@stellar/design-system-website/) -

  website for the design system.

This project is tested with

[BrowserStack](https://email.browserstack.com/c/eJwlzE1uwyAURtHV1DOQMf8D1lIB7yNBcewaSNl-LXV8dS6CMNas0imrFwo6abJLDUbCaKE2CCPNt1RpS8KQLQlIq9LCb94W3ivhVS9WGq4PjsEKsZ-TPh2xD8HesR6SPRpwMO3JOefJs3yZPL_Uijvv_Kb9Segvns_38gxZSYKzSaikfIFdBbIUSWFD1NbFZQ9zTp7aOTtaHzH_yxbqL0a8v31g32PjZ3v8AQZ4Rr0).

### Scripts

`build:sds` build Stellar Design System (`sds`) project only

`build:sds-web` build Stellar Design System Website (`sds-web`) project only

`build` build both projects

`start:sds` start `sds` project for local development

`start:sds-web` start `sds-web` project for local development

`clean` delete `node_modules` and `build` directories in the whole repo

**Note** You need to run each `start` command in its own window or tab.