postshape v1.0.0

Getting Started

Install with your favourite package manager

yarn add preshape

Import and start using

import React from 'react';
import { render } from 'react-dom';
import { Flex, Text } from 'preshape';

const rootElement = document.getElementById('Root');

if (rootElement) {
  render((
    <Flex alignChildren="middle" direction="vertical" grow>
      <Flex>
        <Icon name="Preshape" margin="x2" size="24px" />
        <Text margin="x2" strong>Ready!</Text>
      </Flex>
    </Flex>
  ), rootElement);
}

Documentation

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

Technology

• Typescript
• Parcel (bundler and dev servers)
• React
• PostCSS (with postcss-preset-env for a little power)
• Firebase (hosting)

Setup

Prerequisites

• Node - Either use nvm use or checkout the tested version inside the .nvmrc file.

Setup

Clone the repository

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

Install the dependencies with your favourite package manager

yarn install

Running

Spin up the Parcel development server

yarn start

Building the static site

Build the static files using Parcel

yarn build:site

Building the library

Build the static files using Parcel

yarn build:lib

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.