waktaplay / ui

SpaceWak Design System

SpaceWak Design System

This repository provides a list of components commonly used by services operated by the Team SpaceWak.

Installation

If you are installing this library first time, please run the following command first.

You may need to issue the GitHub Personal Access Token (legacy) to run this script.

# Windows + Powershell
Invoke-WebRequest -Uri 'https://github.com/waktaplay/ui/raw/main/scripts/registry-setup.ps1' -OutFile '.\registry-setup.ps1'
Start-Process '.\registry-setup.ps1' -Wait
Remove-Item '.\registry-setup.ps1'

# macOS or Unix/Linux
curl -fsSL 'https://github.com/waktaplay/ui/raw/main/scripts/registry-setup.sh' -o registry-setup.sh
chmod +x registry-setup.sh

./registry-setup.sh
rm registry-setup.sh

To install the SpaceWak Design System, you can use the following command:

# Npm
npm install @waktaplay/ui

# Yarn
yarn add @waktaplay/ui

# pnpm
pnpm add @waktaplay/ui

We highly recommend using pnpm, as yarn has some issues while installing libraries from our registry.

Usage

To use the SpaceWak Design System, you can import the components you need from the package:

import { Button } from "@waktaplay/ui"

function App() {
  return <Button>Click me!</Button>
}

License

This project is not licensed as public domain. Please contact the Team SpaceWak for more information.

Copyright © 2024 Team SpaceWak. All rights reserved.