Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mergestat/blocks
Mergestat UI Components
https://github.com/mergestat/blocks
Last synced: 7 days ago
JSON representation
Mergestat UI Components
- Host: GitHub
- URL: https://github.com/mergestat/blocks
- Owner: mergestat
- License: mit
- Created: 2022-11-16T20:11:15.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-10-23T06:05:23.000Z (21 days ago)
- Last Synced: 2024-10-24T20:57:33.153Z (19 days ago)
- Language: TypeScript
- Size: 3.01 MB
- Stars: 5
- Watchers: 4
- Forks: 0
- Open Issues: 20
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: CODEOWNERS
Awesome Lists containing this project
README
# MergeStat UI Libraries
This repository is a monorepo manage with [Nx](https://nx.dev/).
## Packages
- [MergeStat Blocks](https://github.com/mergestat/blocks/tree/main/packages/blocks) : React UI components used to build the MergeStat App
- [MergeStat Icons](https://github.com/mergestat/blocks/tree/main/packages/icons) : React Icons used to build the MergeStat App
## How to use
Clone the repository
```sh
git clone https://github.com/mergestat/blocks.git
```Run project at the root of the workspace
```sh
cd blocks
npm install
```Run blocks on storybook
```sh
npm run start:blocks
```Run icons on storybook
```sh
npm run start:icons
```## How to Publish to NPM
Go to `packages/blocks/package.json` and upgrade the version manually.
```json
{
"name": "@mergestat/blocks",
"version": "1.2.6", <-----------
}
```Then `login`, `build` and `publish`
```sh
npm login
``````sh
npm run release
```## Architecture
![repo structure](./public/blocks-architecture.svg)