Skip to content

littlehorse-enterprises/ui-library

Repository files navigation

LittleHorse UI Component Library

LittleHorse's UI component library built with shadcn/ui. This is for internal use of all LittleHorse frontend projects. This repo contains reusable "building block" components that each project can use to maintain a consistent and synchronized UI/UX. It is built on top of the foundation of shadcn.

Installation

npm install @littlehorse-enterprises/ui-library

Usage

Make sure to import the CSS file in your main entry point as this has the required styles for the components to work.

import '@littlehorse-enterprises/ui-library/index.css'
import { Button } from '@littlehorse-enterprises/ui-library/button'

export default function App() {
  return (
    <Button variant="default">
      Click me
    </Button>
  )
}

Development

# Install dependencies
npm install

# Set up Git hooks with Husky
npx husky install
# It is going to say the command is deprecated, but husky says we can ignore that because we are a library with consumers not an app. So we don't want to do postinstall script that would effect consumers of the library.

# Start development server
npm run dev

# Build library
npm run build

About

LittleHorse's UI component library built with shadcn/ui.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors 2

  •  
  •