Installation

Get MiniKit up and running in your project using npm or a CDN.

MiniKit can be installed into modern build-based projects or used directly in static HTML pages without any build tooling.

Install with npm

Install MiniKit from npm when using a bundler, framework, or build tool.

npm install @ajay007e/minikit

For static websites or quick prototypes, MiniKit can be loaded directly from a CDN.

Add the stylesheet and JavaScript bundle to your page.

Include the MiniKit stylesheet in the document head.

<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@ajay007e/minikit@latest/dist/minikit.min.css"/>

Include the JavaScript bundle before the closing body tag.

<script src="https://cdn.jsdelivr.net/npm/@ajay007e/minikit@latest/dist/minikit.min.js"></script>

Once MiniKit is installed, create a simple button to verify that the stylesheet and JavaScript bundle are loading correctly.

Preview Code

<button>Hello MiniKit</button>

If the button appears with MiniKit styling, the installation was successful and you're ready to start building.

Continue to the component documentation to explore the available components, utilities, and customization options.