---

Swarmakit

Swarmakit offers reusable UI components for React, Vue, and Svelte that integrate seamlessly into Vite-powered applications.

Each framework's components are built with TypeScript for type safety and optimized for performance, designed with best practices to take full advantage of Vite's fast development environment.

Installation

1. Prerequisites

To install Swarmakit libraries, ensure npm is installed. Run the following command:

npm install npm@latest -g

2. Initialize a Vite Application

To Start a new project with Vite and TypeScript for each framework, use the following commands:

Vue 3 + TypeScript

npm create vite@latest my-vue-app -- --latest vue-ts
cd my-vue-app
npm install

replacing my-vue-app with your project's name

React + TypeScript

npm create vite@latest my-react-app -- --latest react-ts
cd my-react-app
npm install

replacing my-react-app with your project's name

Svelte + TypeScript

npm create vite@latest my-svelte-app -- --latest svelte-ts
cd my-svelte-app
npm install

replacing my-svelte-app with your project's name

3. Install Swarmakit Libraries

Install the Swarmakit component libraries for each framework as needed:

npm install @swarmakit/vue @swarmakit/react @swarmakit/svelte

For framework specific setup and best practices please refer to their specific documentation:

1. React Library Doc
2. Svelte Library Doc
3. Vue Library Doc

Want to help?

If you want to contribute to Swarmakit, read up on our guidelines for contributing that will help you get started.