https://github.com/autoinvent/conveyor

https://github.com/autoinvent/conveyor

Last synced: 2 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/autoinvent/conveyor
• Owner: autoinvent
• License: other
• Created: 2023-07-22T02:50:40.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-10-24T22:03:44.000Z (3 months ago)
• Last Synced: 2024-10-25T06:50:57.322Z (3 months ago)
• Language: TypeScript
• Homepage: https://autoinvent.github.io/conveyor/
• Size: 44.4 MB
• Stars: 2
• Watchers: 2
• Forks: 9
• Open Issues: 21
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# Conveyor

Conveyor is a comprehensive React UI library for quickly building UI components to interact with GraphQL APIs generated by the [Magql](https://github.com/autoinvent/magql) library. It provides an intuitive and user-friendly interface for performing CRUD (Create, Read, Update, Delete) operations on your GraphQL data.

## Usages

Both a UMD module and ES module exist, allowing Conveyor to be used either as an npm package with the command:

```bash

pnpm install @autoinvent/conveyor

```

```jsx

import Conveyor from '@autoinvent/conveyor'

```

or via a CDN with the following link tag:

```html

  

```

**Note**: React is not used in the final bundle and needs to be installed separately.  

## Scripts

- `pnpm build` - Build library for production; The generated files will be on the `dist` folder. 

- `pnpm build:css` - Run tailwind CLI tool to build the css file.

- `pnpm storybook` - run storybook

- `pnpm format` - Format all files with Biome.

- `pnpm lint` - Scan all files for linting errors with Biome.

## Useful commands

- `pnpm pack` will package the files from `pnpm build` into a tarball for install.