https://github.com/jonambas/react-delver-ui

https://github.com/jonambas/react-delver-ui

Last synced: 3 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/jonambas/react-delver-ui
• Owner: jonambas
• Created: 2022-06-27T23:02:47.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-01-20T22:49:20.000Z (12 months ago)
• Last Synced: 2024-01-20T23:33:26.061Z (12 months ago)
• Language: TypeScript
• Homepage: react-delver-ui.vercel.app
• Size: 189 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 11
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# react-delver-ui

A standalone UI built for [react-delver](https://github.com/jonambas/react-delver) that can installed and deployed with your React code.

Demo: https://react-delver-ui.vercel.app/

---

Usage

```bash

npm i react-delver-ui --save-dev

```

Create a `delver.config.js` config file in the root directory of your project.

```js

/**

 * @type {import('react-delver-ui').Config}

 */

export default {

  include: [

      '**/*.{jsx,tsx,js,ts}',

      '!**/*.stories.{jsx,tsx,js,ts}',

      '!**/node_modules',

      '!**/dist'

    ],

  port: 8080,

  outputPath: 'dist/delver-ui',

  title: 'My App'

};

```

Add the following scripts to `package.json`

```json

"scripts": {

  "start:delver": "delver start",

  "build:delver": "delver build"

},

```

Run the app!

```bash

npm run start:delver

```

---

## `delver.config.js` Options

This config object extends the `react-delver` config options. See [https://github.com/jonambas/react-delver#node-api](https://github.com/jonambas/react-delver#node-api) for a full list of JSX parsing options.

#### `port`

#### `outputPath`

#### `title`

#### `openBrowser`

#### `base`