https://github.com/yoctol/tailor-ui

A bespoke UI collection for building web application.
https://github.com/yoctol/tailor-ui

react react-spring styled-components

Last synced: about 2 months ago
JSON representation

A bespoke UI collection for building web application.

• Host: GitHub
• URL: https://github.com/yoctol/tailor-ui
• Owner: Yoctol
• Created: 2018-12-04T09:35:29.000Z (about 6 years ago)
• Default Branch: develop
• Last Pushed: 2023-02-03T13:38:57.000Z (almost 2 years ago)
• Last Synced: 2024-05-29T15:36:05.455Z (7 months ago)
• Topics: react, react-spring, styled-components
• Language: TypeScript
• Homepage: https://tailor-ui.netlify.app/
• Size: 11.4 MB
• Stars: 10
• Watchers: 5
• Forks: 0
• Open Issues: 20
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md

Awesome Lists containing this project

README

        
# Tailor UI

[![npm](https://img.shields.io/npm/v/tailor-ui.svg)](https://www.npmjs.com/package/tailor-ui)

[![CircleCI](https://circleci.com/gh/Yoctol/tailor-ui.svg?style=shield&circle-token=3586bec62e7ddc76eca1227bc7a168d680169e09)](https://circleci.com/gh/Yoctol/tailor-ui)

[![style: styled-components](https://img.shields.io/badge/style-%F0%9F%92%85%20styled--components-orange.svg?colorB=daa357&colorA=db748e)](https://github.com/styled-components/styled-components)

[![Netlify Status](https://api.netlify.com/api/v1/badges/7e31ae18-19bf-4a55-9feb-a5b13dc4fcc4/deploy-status)](https://app.netlify.com/sites/tailor-ui/deploys)

## Documentation

Check out our [documentation website](https://tailor-ui.netlify.app).

## Installation

```bash

# with npm

npm install tailor-ui

# with yarn

yarn add tailor-ui

```

## Usage

Here is a quick example to get you started, it's all you need:

```js

import React from 'react';

import ReactDOM from 'react-dom';

import { Button, UIProvider } from 'tailor-ui';

const App = () => (

  

    Hello World

  

);

ReactDOM.render(, document.querySelector('#root'));

```

## Development

```bash

git clone [email protected]:Yoctol/tailor-ui.git

```

First, open the terminal to watch the file changing and do the type checking:

```bash

cd tailor-ui

yarn watch

```

And then, open another tab to run the project:

```bash

cd tailor-ui

yarn start

```

### Release

- Send PR to `develop` branch during development.

- When you want to release the version, merge `develop` branch into `master` branch, and then `sematic release` will automatically release new version on CI.

  - Make sure [Environment Variables](https://app.circleci.com/settings/project/github/Yoctol/tailor-ui/environment-variables) on CircleCI are setup correctly. `GH_TOKEN` need to have `repo` scope and `NPM_TOKEN` need to have access to [`tailor-ui`](https://www.npmjs.com/package/tailor-ui/) package.

- After new version released, merge `master` back to `develop`.