README.md

Pirati UI kit

This repository holds UI styleguide for Czech Pirate Party websites. It's intention is to made a core framework to be used across all sites and build all UI using it. This will ensure better consistency a easier updates.

It is built upon:

• Patternlab is a tool for developing design systems
• Tailwind CSS is a brilliant utility-first CSS framework built on top of PostCSS

Getting Started

These instructions are for getting the project running off a local development environment:

• Install any system requirements on your dev environment
• Use NPM to install project dependencies and build the project

System Requirements

• Node.js (v14.5.x or later)

Install and Run

It's JavaScript all the way down so once you have the the system requirements you can run the following commands:

npm i
npm run develop

The npm command will install project dependencies and the npm run develop command builds the project, sets up a local server for the Patternlab UI and watches relevant template files to rebuild on any changes.

Build

The build command compiles the styleguide CSS and the Patternlab output but it doesn't create a server for the styleguide website. To build, run:

npm run build

Releasing

First build for production as described previously:

npm run build

Now, make new version using semver principle: