Skip to content

HHogg/preshape

Repository files navigation

Preshape

A design system and component library for my own personal projects. Take a look around. However, you probably shouldn't use this in your project as there's no guarantee of stability or support.

Using the library

Install with your favourite package manager

yarn add preshape

Add the CSS to your project, e.g.

import 'preshape/dist/style.css';

then import and start using components.

import { Box } from 'preshape';

<Box>...</Box>

Documentation

Description of the design system and component documentation can be found on the Preshape site.

Development

Prerequisites

Node

Yarn

Setup

Clone the repository

git clone git@github.com:HHogg/preshape.git

Install the dependencies with your favourite package manager

yarn

Spin up the dev server

yarn dev

Contribution

Preshape uses a strict commit message structure that follows the Conventional Commits spec. This is used to automate publishing the package to NPM and generating the changelog with Semantic Release.