❤️ Support our project - Your donation helps us continue developing awesome tools!


Docs
Installation

Installation

How to install dependencies and structure your app.

Frameworks

TypeScript

This project and the components are written in TypeScript. We recommend using TypeScript for your project as well because it provides better tooling, improved code quality, and easier refactoring.

However we provide a JavaScript version of the components as well. The JavaScript version is available via the cli.

To opt-out of TypeScript, you can use the tsx flag in your nyxbui.json file.

nyxbui.json
{
  "style": "default",
  "tailwind": {
    "config": "tailwind.config.ts",
    "css": "app/styles/globals.css",
    "baseColor": "zinc",
    "cssVariables": true
  },
  "rsc": false,
  "tsx": false,
  "aliases": {
    "utils": "~/lib/utils",
    "components": "~/components"
  }
}

To configure import aliases, you can use the following jsconfig.json:

jsconfig.json
{
  "compilerOptions": {
    "paths": {
      "~/*": ["./*"]
    }
  }
}