feremabraz / monster-designsystem

Tailwind CSS Design System for GameKaiju & AppKaiju. Currently not in use by them.

Home Page:https://monster-designsystem.vercel.app

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Design System for Gamekaiju & Appkaiju

Using Tailwind and Ladle.

Screenshot

How to develop?

# using pnpm is adviced
pnpm install

# start the development mode
pnpm dev

# if you want to check how the static site will look like
pnpm serve

How to publish?

Project is configured to do a package publish on every commit to main. So, after the commits containing your work, but before pushing to main, on a working tree clean, do:

npm version <major|minor|patch>
git push --all origin

How to consume?

If the project is configured to be private, source code will not be public. Nonetheless, you can consume it in another project as follows:

npm install @feremabraz/monster-designsystem
pnpm add @feremabraz/monster-designsystem

In that case, for it to work while consuming it, you will need a Personal Access Token (classic) with at least read:packages permissions.

//npm.pkg.github.com/:_authToken=TOKEN
@YOUR_ORGANIZATION:registry=https://npm.pkg.github.com

How to deploy a static site?

Configure your Vercel deployment to use Vite and the same scripts that the package uses instead of the default ones, i.e. the following:

Vercel Deployment

About

Tailwind CSS Design System for GameKaiju & AppKaiju. Currently not in use by them.

https://monster-designsystem.vercel.app

License:MIT License


Languages

Language:TypeScript 79.4%Language:JavaScript 20.4%Language:Shell 0.1%Language:CSS 0.1%