Use with Blitz.js - Flowbite React

Learn how to install Flowbite React with Blitz.js

This guide provides three ways to integrate Flowbite React with Blitz.js:

  1. Quick Start: Create a new project with everything pre-configured
  2. Add to Existing Project: Add Flowbite React to an existing Blitz.js project
  3. Manual Setup: Set up everything from scratch manually

Quick Start (Recommended)

Quick Start#

The fastest way to get started is using our project creation CLI, which sets up a new Blitz.js project with Flowbite React, Tailwind CSS, and all necessary configurations:

npx create-flowbite-react@latest -t blitzjs

This will:

  • Create a new Blitz.js project
  • Install and configure Tailwind CSS
  • Set up Flowbite React with all required dependencies
  • Configure dark mode support
  • Set up example components

Add to Existing Project

Add to Existing Project#

If you already have a Blitz.js project and want to add Flowbite React, you can use our initialization CLI:

npx flowbite-react@latest init

This will automatically:

  • Install Flowbite React and its dependencies
  • Configure Tailwind CSS to include Flowbite React plugin
  • Set up necessary configurations

Manual Setup

Manual Setup#

If you prefer to set everything up manually or need more control over the configuration, follow these steps:

1. Create Project#

Create a new Blitz.js project:

npm install -g blitz
blitz new blitzjs-project
cd blitzjs-project

2. Configure Tailwind CSS#

Install Tailwind CSS and its dependencies:

npm install -D tailwindcss @tailwindcss/postcss postcss

Create a postcss.config.mjs file:

touch postcss.config.mjs

Add @tailwindcss/postcss to your postcss.config.mjs file:

/** @type {import('postcss-load-config').Config} */
const config = {
  plugins: {
    "@tailwindcss/postcss": {},
  },
};
export default config;

Update the css file src/app/globals.css to include Tailwind CSS:

@import "tailwindcss";

3. Install Flowbite React#

Install Flowbite React:

npx flowbite-react@latest init

This will:

  • Install Flowbite React and its dependencies
  • Configure Tailwind CSS to include Flowbite React plugin
  • Configure Vite to include Flowbite React plugin

Try it out#

Now that you have successfully installed Flowbite React you can start using the components from the library:

// app/pages/index.tsx
import { Button } from "flowbite-react";

function Home() {
  return (
    <div className="p-4">
      <h1 className="mb-4 text-2xl font-bold">Welcome to Blitz.js with Flowbite React</h1>
      <Button>Click me</Button>
    </div>
  );
}

export default Home;

Templates#