Skip to main content

Learn how to get started with MynaUI.

Introduction

MynaUI is a modern, accessible, and customizable UI library built with TailwindCSS. It is designed to help you build beautiful and functional web applications quickly and easily.

I recommend starting by signing up for a new account by using the sign in button at the top of the page. This will give you access to the components and documentation.

Installation

Install TailwindCSS

If you are new to TailwindCSS, you can get started with the official documentation.

We always use the latest version of TailwindCSS, to make sure you have the latest version, run the following command:

npm install tailwindcss@latest

One tailwind plugin we use is @tailwindcss/typography, to install it run the following command:

npm install -D @tailwindcss/typography@latest

To learn more about the @tailwindcss/typography plugin visit their documentation.

Install shadcn/ui

We use shadcn/ui for all the components in MynaUI. To install it, refer to their documentation.

After installing, your components.json should look something like this:

{
  "$schema": "https://ui.shadcn.com/schema.json",
  "style": "default",
  "rsc": true,
  "tsx": true,
  "tailwind": {
    "config": "tailwind.config.js",
    "css": "app/globals.css",
    "baseColor": "slate",
    "cssVariables": true,
    "prefix": ""
  },
  "aliases": {
    "components": "@/components",
    "utils": "@/lib/utils",
    "ui": "@/components/ui",
    "lib": "@/lib",
    "hooks": "@/hooks"
  }
}

Install Geist Font

We use geist font for all the typography in MynaUI. To install it, refer to their documentation.

Install MynaUI Icons

We use MynaUI Icons for all the icons. To install into shadcn/ui project, run the following command:

npx shadcn@latest add https://mynaui.com/icons/shadcn.json

Or install into a react project, run the following command:

npm install @mynaui/icons-react

To learn more about the MynaUI Icons, visit our documentation.

Default Class (Optional)

We use a default class for all the components in MynaUI. To use it, add the following class to the root (html tag) element of your application:

<html className="font-geist-sans text-sm antialiased"></html>

This will apply the default font and text size to all the components in MynaUI.

That's it! You are now ready to start building your app 🎉.