Development
Development guidelinesLink to this heading
Our GitHub source is a monorepo containing this docs app and the React library. The README should include any relevant tips for running the project locally and working on it. Please feel free to
Strum Design System is the personal component library for Colin Hemphill, a front end dev in Austin, TX. I cannot guarantee any availability to work on this project, but you are welcome to post issues or make pull requests and I'll try to get to it if I can.
git clone git@github.com:colinhemphill/strum.gitcd strumyarnyarn dev
Open-source acknowledgmentsLink to this heading
This vanity project was made possible by lots of great open-source software:
- Vanilla Extract for all styling and theming. Vanilla Extract is my favorite styling solution, providing zero-runtime stylesheets with type safety, and lots of great addons like recipes and atomic styles with Sprinkles.
- Radix UI for accessible primitives on which some of my components are built. Our color system is also based on Radix UI Colors.
- next-themes as the basis for my <StrumProvider /> strategies, and Josh Comeau for his formative work in crafting the perfect dark mode.
- Modern Normalize for CSS resets. Special shoutout to this CSS-to-vanilla-extract converter which made it real easy to port the reset!
- TypeScript obviously.
- Turborepo for managing the monorepo.
- Next.js to produce this documentation site.
- MDX and a bunch of related libraries for documentation.
- React Live for documentation sandboxes.
- ESLint, Prettier, Husky, and lint-staged
- Jest
- React Testing Library
I regret to inform you that my architecture is largely based on degen, the design system for some Web3 nonsense. Although most of my components were built from scratch, I forked from degen and still rely on much of their tech design for base styles, atoms, and documentation. They're doing great work for the wrong cause.