@pinegrow/astro-module/README.md

Pinegrow Astro Module

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

# Pinegrow Astro Module

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

[Astro](https://astro.build/) module for [Pinegrow](https://pinegrow.com) ⚡️

Pinegrow Astro 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 Astro apps (currently only Vue components are supported)
-   ⚙️&nbsp; Smartly integrates into your Astro 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/astro-module` to your project

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

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

2. Configure: Add `@pinegrow/astro-module` to your Astro Integrations array `astro.config.{mjs,ts}`

```js
//astro.config.mjs (or) astro.config.ts

import { defineConfig } from 'astro/config'

import vue from '@astrojs/vue'
import Pinegrow from '@pinegrow/astro-module'

export default defineConfig({
	integrations: [
		vue(),
		Pinegrow({
			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/astro-module/latest.svg?style=flat&colorA=18181B&colorB=28CF8D
[npm-version-href]: https://npmjs.com/package/@pinegrow/astro-module
[npm-downloads-src]: https://img.shields.io/npm/dm/@pinegrow/astro-module.svg?style=flat&colorA=18181B&colorB=28CF8D
[npm-downloads-href]: https://npmjs.com/package/@pinegrow/astro-module
[license-src]: https://img.shields.io/npm/l/@pinegrow/astro-module.svg?style=flat&colorA=18181B&colorB=28CF8D
[license-href]: https://npmjs.com/package/@pinegrow/astro-module