Skip to content

Starter kit designed for developing Figma plugins using modern technologies like Vite, React, and Nanostores.

License

Notifications You must be signed in to change notification settings

mikhin/figma-plugin-boilerplate

 
 

Repository files navigation

Figma Plugin Boilerplate

License: MIT

Starter kit designed for developing Figma plugins using modern technologies like Vite, React, and Nanostores.

Features

  • Vite: For fast, unbundled development, optimized with esbuild.
  • React: To build UI with modern React features.
  • Nanostores: For state management in React components.
  • Tailwind CSS: For styling components with utility-first CSS.
  • TypeScript: Strongly typed programming language that builds on JavaScript.
  • ESLint & Prettier: For code quality and formatting.
  • Vitest: For unit testing of your components and API.
  • Continuous Integration: Configured GitHub Actions for automated testing.

Getting Started

To use this boilerplate, follow these steps:

Clone the Repository

git clone https://github.com/mikhin/figma-plugin-boilerplate.git

Install Dependencies

pnpm install

Start Development

  • For UI development: pnpm run dev:ui
  • For API development: pnpm run dev:api

Build for Production

  • Build UI: pnpm run build:ui
  • Build API: pnpm run build:api

Testing

  • Run lint checks: pnpm test:lint
  • Run type checks: pnpm test:types
  • Execute unit tests: pnpm test:unit:ui and pnpm test:unit:api

License

This project is licensed under the MIT License.

Caution

Note: Always remember to replace placeholders like <REPLACE_WITH_YOUR_NAME> in the manifest.json with your actual details.

About

Starter kit designed for developing Figma plugins using modern technologies like Vite, React, and Nanostores.

Topics

Resources

License

Stars

Watchers

Forks

Languages

  • TypeScript 76.1%
  • JavaScript 20.0%
  • HTML 2.8%
  • CSS 1.1%