@tucar/pit-stop NPM

Pit-Stop is a react based UI components library build to make the development of the Tucar Applications faster

Installation

Pit-Stop is available as an npm package

npm:

npm install @tucar/pit-stop

yarn:

yarn add @tucar/pit-stop

Getting Started with Pit-Stop

Here is an exampl of a basic app using Pit-Stop and it's Button component:

import React from 'react';
import { ThemeProvider, Button } from "@tucar/pit-stop";

const App = () => (
    <ThemeProvider>
        <Button>
            Hello World
        </Button>
    </ThemeProvider>
)

Notice that Theme Provider component is a Theme Wrapper Component needed in order to add all the given styles to the different components that are on this package.

Examples

This section is in progress

License

This project is licensed under the terms of the MIT license.

Develop:

With Docker

Run project: To run the project you need docker and then run it with make!
```
make ui
```

Without Docker

Install project dependencies
```
yarn install
```
Run the StoryBook and enjoy our library
```
yarn storybook
```

Release

In order to release the application you have two possible ways:

Release with publish.yml

Create a Github Release pointing to the main branch with a tag in the format v.x.x.x

release with release_package.yml

Build a description of the changes on CHANGELOG.md under the Unpublished tag.
Go to actions and run Release package action. This will ask you a release level to get the correct name of the version.

To get more information visit the page https://superface.ai/blog/npm-publish-gh-actions-changelog