joshblack / super-awesome-design-system

Sandbox for building out super awesome design systems

Home Page:https://super-awesome-design-system.vercel.app/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Super Awesome Design System

js rust security

Sandbox for building out super awesome design systems

This project is a personal development environment for trying out different techniques for building a design system. This includes multiple ways of building components, different styling strategies, building websites, CLI commands, and more.

This work is not intended to be stable or used as a reference. It's just meant to be fun. If you're checking out this project, hope it's helpful!

Getting started

These are the notes that I'm using to remember how to use this project :sweat_smile:

Prerequisites

You will need to have the following installed on your machine:

Commands

Language Command Description
JavaScript yarn Install JavaScript dependencies for the monorepo
JavaScript yarn format Format files in the project using prettier
JavaScript yarn dedupe Determine if we can deduplicate packages based on overlapping package ranges
Rust cargo fmt Format rust files using cargo fmt
Rust cargo test Run the tests for the Rust files in the workspace
Rust cargo clippy Run clippy on files in the Rust workspace
Rust cargo install --path cli Install the dsm cli as an executable on your machine

Project Overview

This repo is broken up into several parts, including:

  • The dsm cli used for managing common design system tasks in a monorepo
  • A collection of component packages that make up the design system
  • A collection of generic packages for building the design system
  • A website for displaying information about the project, from documentation to blog posts

Links & Inspiration

This list of projects and resources are ones that I've found inspirational or referenced heavily during the course of exploring concepts in this repo. I want to give each of them a huge shoutout for how helpful they've been:

Radix UI

Homepage | Primitives | Website

Radix is always an inspiration, whether that's for accessible component implementations in React, how they've organized their projects, or the awesome website that they've made.

Mantine

Homepage

The spread of the mantine library is incredible, covering a wide variety of hooks and components. I love referencing what this project is doing and seeing what gaps there are in the React component space in my own design systems.

TypeScript

This project is one of my first using TypeScript. This is a growing list of TypeScript resources that I found helpful along the way.

📝 License

Licensed under the MIT License.

About

Sandbox for building out super awesome design systems

https://super-awesome-design-system.vercel.app/

License:MIT License


Languages

Language:JavaScript 43.4%Language:TypeScript 29.9%Language:SCSS 16.1%Language:Rust 10.3%Language:Shell 0.4%