**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](https://www.npmjs.com/package/@tucar/pit-stop)
## 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:
```jsx
import React from 'react';
import { ThemeProvider, Button } from "@tucar/pit-stop";
const App = () => (
)
```
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](/LICENSE).
# Develop:
## With Docker
1. Run project: To run the project you need docker and then run it with make!
```
make ui
```
## Without Docker
1. Install project dependencies
```
yarn install
```
2. 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
# Usefull links:
- [Tucar UI Kit - Adobe XD](https://xd.adobe.com/view/8bb1374f-8814-4354-809b-77d984c556d1-dee2/)
