@pinegrow/iles-module/README.md

Pinegrow Iles Module

<!-- [![@pinegrow/iles-module](https://tailwindcss.nuxtjs.org/social-card.png)](https://tailwindcss.nuxtjs.org) -->

# Pinegrow Iles Module

[![npm version][npm-version-src]][npm-version-href]
[![npm downloads][npm-downloads-src]][npm-downloads-href]
[![License][license-src]][license-href]

[Iles](https://iles.pages.dev/) module for [Pinegrow](https://pinegrow.com) ⚡️

Pinegrow Iles Module enables connection and interaction between your Vite Dev-Server and Pinegrow apps (currently only Vue Designer).

-   [&nbsp;Learn more about Vue Designer](https://vuedesigner.com)

## Features

-   🎨&nbsp; Visually live-design your Vite-powered Iles apps
-   ⚙️&nbsp; Smartly integrates into your Iles workflow in dev-mode only
-   ✨&nbsp; Clean code 😃, No lock-in - You are in control of your projects and development workflow ❤️

## Quick Setup

1. Install: Add `@pinegrow/iles-module` to your project

```bash
# Using npm
npm install -D @pinegrow/iles-module

# Using pnpm
pnpm add -D @pinegrow/iles-module
```

2. Configure: Add `@pinegrow/iles-module` to your Iles Integrations array `iles.config.{js,ts}`

```js
//iles.config.js (or) iles.config.ts

import { defineConfig } from 'iles'

export default defineConfig({
	modules: [
		[
			'@pinegrow/iles-module',
			{
				liveDesigner: {
					// For options, refer to https://www.npmjs.com/package/@pinegrow/vite-plugin
					//...
				},
			},
		],
		//...
	],
	//...
})
```

Now, open your project in your Pinegrow app (currently only Vue Designer). ✨

## License

[MIT License](./LICENSE)

Copyright (c) Pinegrow

<!-- Badges -->

[npm-version-src]: https://img.shields.io/npm/v/@pinegrow/iles-module/latest.svg?style=flat&colorA=18181B&colorB=28CF8D
[npm-version-href]: https://npmjs.com/package/@pinegrow/iles-module
[npm-downloads-src]: https://img.shields.io/npm/dm/@pinegrow/iles-module.svg?style=flat&colorA=18181B&colorB=28CF8D
[npm-downloads-href]: https://npmjs.com/package/@pinegrow/iles-module
[license-src]: https://img.shields.io/npm/l/@pinegrow/iles-module.svg?style=flat&colorA=18181B&colorB=28CF8D
[license-href]: https://npmjs.com/package/@pinegrow/iles-module