@nulib/design-system
v1.6.2
Published
[https://nulib.github.io/design-system/](https://nulib.github.io/design-system/)
Downloads
477
Keywords
Readme
Design System for Northwestern University Libraries
https://nulib.github.io/design-system/
A global design system for NUL ReactJS UI components, intended for all front end applications, NPM modules, and user interfaces.
Built using:
- React
- TypeScript
- Radix Primitives to be "accessibility-first",
- Stitches package for styling
- NextJS for dev environment
- Rollup for package bundling
Usage
Install the package
npm install @nulib/design-system
Import individual components
import { Button, Section, Tag } from "@nulib/design-system"
...
<Button
isPrimary
onClick={() => console.log("Ive been clicked")}
>
Click Me
</Button>
Development
// Clone the repo
git clone [email protected]:nulib/design-system.git
// Install dependencies
npm install
// Run the local dev environment
npm run dev
Open http://localhost:3000 with your browser to see the result.
Packaging
Build for NPM
npm run build
Build static reference site for Github Docs
npm run build:static
Per NextJS convention, this will output to the /out
directory. To view a local static build via a quick local server, run:
npm run build:static
npx serve out
CI
A static version of the site is automated and pushed to the gh-pages
branch via Github Actions commits to the main
branch. View the static site at: https://nulib.github.io/design-system/