Skip to content

gotpop/system

Repository files navigation

GotPop System

License Lint Format Check Type Check Netlify Status

Design system monorepo for gotpop projects with TypeScript-first distribution via GitHub Packages (Public)

🚀 Live Storybook: system.gotpop.io
📦 Component Library: TypeScript-first design system with Storyblok integration

📦 Published Package

@gotpop/system - Available on GitHub Packages (Public)

# Configure .npmrc to use GitHub Packages for @gotpop scope
echo "@gotpop:registry=https://npm.pkg.github.com" >> .npmrc

# Install via npm
npm install @gotpop/system

# Or via yarn
yarn add @gotpop/system

Quick Start

# Install dependencies
yarn install

# Start development
yarn dev

# Build all packages
yarn build

# Lint all packages
yarn lint

Structure

  • packages/system - Main package published to JSR 🚀
  • apps/storybook - Component documentation

Development

See individual package READMEs for specific development instructions.

Publishing

The main package is published to GitHub Packages as a public package:

Manual Publishing

# From root directory
yarn publish:github

# Or from packages/system directory
cd packages/system
npm publish

Automated Publishing

Publishing happens automatically via GitHub Actions when:

  • Changes are pushed to master branch in packages/system/
  • Version is auto-incremented (patch version)
  • Package is published to GitHub Packages after successful type checking

GitHub Packages Features

  • Public registry: Open-source package distribution via GitHub
  • GitHub integration: Seamless authentication with GitHub tokens
  • Version management: Full npm-compatible versioning
  • TypeScript support: Full TypeScript support with type definitions

Visit @gotpop/system on GitHub Packages for the published package.

About

A custom component system for building Next.js RSC with StoryBlok data.

Topics

Resources

Stars

Watchers

Forks

Packages