QA Team Sample Plugin

This repository includes a QA testing sample plugin.

URL to test the plugin

This plugin can be tested using the following url to install it in penpot: https://penpotqa-plugins.pages.dev/manifest.json

Run the plugin on your local

Clone the repository

Clone the repository to start working with it:

git clone <your-repository-url>

Install Dependencies

After cloning the repository, navigate into the project directory and install the necessary dependencies by running:

cd penpotqa-plugins
npm install

This command installs all the required packages listed in the package.json file.

Configure the Plugin

Next, if you need it, edit the plugin's configuration file:

1. Open the manifest.json file located in the /public folder.
2. Make any necessary changes to the configuration. Note that any modifications to this file require you to restart the development server for changes to take effect.

Run the Development Server

To start the development server, run the following command in your terminal:

npm run dev

Once the server is running, open your web browser and go to http://localhost:4400 to view your plugin in action. Now it is ready to be loaded in Penpot with the url http://localhost:4400/manifest.json.

Libraries Included

The template includes two Penpot libraries to assist in your development:

• @penpot/plugin-styles: This library provides utility functions and resources to help you style your components consistently with Penpot's design system.
• @penpot/plugin-types: This library includes types and API descriptions for interacting with the Penpot plugin API, facilitating the development of plugins that can communicate effectively with the Penpot app.

Build Your Plugin

When you're ready to build your plugin for production, run the following command:

npm run build

This command compiles your TypeScript code and assets into JavaScript, creating a dist folder that contains all the files necessary to deploy your plugin.