shadcn-nx-nextjs-boilerplate

KO | EN

gitlite — search

#python #ai #typescript #golang #android #deep-learning #docker #macos #nodejs #cli #kubernetes #awesome-list #pytorch #openai

shadcn-nx-nextjs-boilerplate

(★ 49)

NX monorepo with shadcn/ui, NextJS 13

shadcn-nx-nextjs-boilerplate Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Link to YouTube tutorial:
https://www.youtube.com/watch?v=Wosa6VrZPW0&lc=Ugz6DhvTIp-TfYZXzVJ4AaABAg

# 1. Init Nx monorepo with NextJS

`npx create-nx-workspace@latest`

`cd my-project/`

`npm i -D @nx/next`

`nx g @nx/next:app web`

you can check NextJS app using `nx serve web` (you must have nx cli)

# 2. Add Tailwind

https://nx.dev/recipes/react/using-tailwind-css-in-react

`npm install -D tailwindcss@latest postcss@latest autoprefixer@latest`

paste to `postcss.config.js`
```ts
const { join } = require('path');

module.exports = {
  plugins: {
    tailwindcss: {
      config: join(__dirname, 'tailwind.config.js'),
    },
    autoprefixer: {},
  },
};
```

paste to `tailwind.config.js`
```ts
const { createGlobPatternsForDependencies } = require('@nx/react/tailwind');
const { join } = require('path');

module.exports = {
  content: [
    join(
      __dirname,
      '{src,pages,components,app}/**/*!(*.stories|*.spec).{ts,tsx,html}'
    ),
    ...createGlobPatternsForDependencies(__dirname),
  ],
  theme: {
    extend: {},
  },
  plugins: [],
};
```

replace `global.css`
```css
@tailwind base;
@tailwind components;
@tailwind utilities;
```

add to `apps/web/project.json`
```json
"options": {
    "postcssConfig": "apps/web/postcss.config.js"
  }
```

# 3. Add ui-components library

`nx g @nx/next:library ui-components`

go to `libs/ui-components` directory

delete `lib` dir, `server.ts` file

create `components` dir, `utils.ts` and `index.ts` file at `libs/ui-components/src`

# 4. Add shadcn/ui

`npm install tailwindcss-animate class-variance-authority clsx tailwind-merge`

`npm install @radix-ui/react-icons`

edit `tailwind.config.js`

get config from shadcn/ui docs:
```js
const { fontFamily } = require("tailwindcss/defaultTheme")

/** @type {import('tailwindcss').Config} */
module.exports = {
  darkMode: ["class"],
  content: ["app/**/*.{ts,tsx}", "components/**/*.{ts,tsx}"],
  theme: {
    container: {
      center: true,
      padding: "2rem",
      screens: {
        "2xl": "1400px",
      },
    },
    extend: {
      colors: {
        border: "hsl(var(--border))",
        input: "hsl(var(--input))",
        ring: "hsl(var(--ring))",
        background: "hsl(var(--background))",
        foreground: "hsl(var(--foreground))",
        primary: {
          DEFAULT: "hsl(var(--primary))",
          foreground: "hsl(var(--primary-foreground))",
        },
        secondary: {
          DEFAULT: "hsl(var(--secondary))",
          foreground: "hsl(var(--secondary-foreground))",
        },
        destructive: {
          DEFAULT: "hsl(var(--destructive))",
          foreground: "hsl(var(--destructive-foreground))",
        },
        muted: {
          DEFAULT: "hsl(var(--muted))",
          foreground: "hsl(var(--muted-foreground))",
        },
        accent: {
          DEFAULT: "hsl(var(--accent))",
          foreground: "hsl(var(--accent-foreground))",
        },
        popover: {
          DEFAULT: "hsl(var(--popover))",
          foreground: "hsl(var(--popover-foreground))",
        },
        card: {
          DEFAULT: "hsl(var(--card))",
          foreground: "hsl(var(--card-foreground))",
        },
      },
      borderRadius: {
        lg: `var(--radius)`,
        md: `calc(var(--radius) - 2px)`,
        sm: "calc(var(--radius) - 4px)",
      },
      fontFamily: {
        sans: ["var(--font-sans)", ...fontFamily.sans],
      },
      keyframes: {
        "accordion-down": {
          from: { height: 0 },
          to: { height: "var(--radix-accordion-content-height)" },
        },
        "accordion-up": {
          from: { height: "var(--radix-accordion-content-height)" },
          to: { height: 0 },
        },
      },
      animation: {
        "accordion-down": "accordion-down 0.2s ease-out",
        "accordion-up": "accordion-up 0.2s ease-out",
      },
    },
  },
  plugins: [require("tailwindcss-animate")],
}
```

merge it with existing `tailwind.config.js` config, final version:
```ts
/** @type {import('tailwindcss').Config} */
const { fontFamily } = require('tailwindcss/defaultTheme');
const { createGlobPatternsForDependencies } = require('@nx/react/tailwind');
const { join } = require('path');

module.exports = {
  darkMode: ['class'],
  content: [
    join(
      __dirname,
      '{src,pages,components,app}/**/*!(*.stories|*.spec).{ts,tsx,html}'
    ),
    ...createGlobPatternsForDependencies(__dirname),
  ],
  theme: {
    container: {
      center: true,
      padding: '2rem',
      screens: {
        '2xl': '1400px',
      },
    },
    extend: {
      colors: {
        border: 'hsl(var(--border))',
        input: 'hsl(var(--input))',
        ring: 'hsl(var(--ring))',
        background: 'hsl(var(--background))',
        foreground: 'hsl(var(--foreground))',
        primary: {
          DEFAULT: 'hsl(var(--primary))',
          foreground: 'hsl(var(--primary-foreground))',
        },
        secondary: {
          DEFAULT: 'hsl(var(--secondary))',
          foreground: 'hsl(var(--secondary-foreground))',
        },
        destructive: {
          DEFAULT: 'hsl(var(--destructive))',
          foreground: 'hsl(var(--destructive-foreground))',
        },
        muted: {
          DEFAULT: 'hsl(var(--muted))',
          foreground: 'hsl(var(--muted-foreground))',
        },
        accent: {
          DEFAULT: 'hsl(var(--accent))',
          foreground: 'hsl(var(--accent-foreground))',
        },
        popover: {
          DEFAULT: 'hsl(var(--popover))',
          foreground: 'hsl(var(--popover-foreground))',
        },
        card: {
          DEFAULT: 'hsl(var(--card))',
          foreground: 'hsl(var(--card-foreground))',
        },
      },
      borderRadius: {
        lg: `var(--radius)`,
        md: `calc(var(--radius) - 2px)`,
        sm: 'calc(var(--radius) - 4px)',
      },
      fontFamily: {
        sans: ['var(--font-sans)', ...fontFamily.sans],
      },
      keyframes: {
        'accordion-down': {
          from: { height: 0 },
          to: { height: 'var(--radix-accordion-content-height)' },
        },
        'accordion-up': {
          from: { height: 'var(--radix-accordion-content-height)' },
          to: { height: 0 },
        },
      },
      animation: {
        'accordion-down': 'accordion-down 0.2s ease-out',
        'accordion-up': 'accordion-up 0.2s ease-out',
      },
    },
  },
  plugins: [require('tailwindcss-animate')],
};
```

edit `global.css`
```css
@tailwind base;
@tailwind components;
@tailwind utilities;

@layer base {
  :root {
    --background: 0 0% 100%;
    --foreground: 222.2 47.4% 11.2%;

--muted: 210 40% 96.1%;
    --muted-foreground: 215.4 16.3% 46.9%;

--popover: 0 0% 100%;
    --popover-foreground: 222.2 47.4% 11.2%;

--border: 214.3 31.8% 91.4%;
    --input: 214.3 31.8% 91.4%;

--card: 0 0% 100%;
    --card-foreground: 222.2 47.4% 11.2%;

--primary: 222.2 47.4% 11.2%;
    --primary-foreground: 210 40% 98%;

--secondary: 210 40% 96.1%;
    --secondary-foreground: 222.2 47.4% 11.2%;

--accent: 210 40% 96.1%;
    --accent-foreground: 222.2 47.4% 11.2%;

--destructive: 0 100% 50%;
    --destructive-foreground: 210 40% 98%;

--ring: 215 20.2% 65.1%;

--radius: 0.5rem;
  }

.dark {
    --background: 224 71% 4%;
    --foreground: 213 31% 91%;

--muted: 223 47% 11%;
    --muted-foreground: 215.4 16.3% 56.9%;

--accent: 216 34% 17%;
    --accent-foreground: 210 40% 98%;

--popover: 224 71% 4%;
    --popover-foreground: 215 20.2% 65.1%;

--border: 216 34% 17%;
    --input: 216 34% 17%;

--card: 224 71% 4%;
    --card-foreground: 213 31% 91%;

--primary: 210 40% 98%;
    --primary-foreground: 222.2 47.4% 1.2%;

--secondary: 222.2 47.4% 11.2%;
    --secondary-foreground: 210 40% 98%;

--destructive: 0 63% 31%;
    --destructive-foreground: 210 40% 98%;

--ring: 216 34% 17%;

--radius: 0.5rem;
  }
}

@layer base {
  * {
    @apply border-border;
  }
  body {
    @apply bg-background text-foreground;
    font-feature-settings: "rlig" 1, "calt" 1;
  }
}
```

add to `libs/ui-components/src/utils.ts`
```ts
import { clsx, type ClassValue } from "clsx"
import { twMerge } from "tailwind-merge"

export function cn(...inputs: ClassValue[]) {
  return twMerge(clsx(inputs))
}
```

create `components.json` at monorepo root
```json
{
  "$schema": "https://ui.shadcn.com/schema.json",
  "style": "new-york",
  "rsc": false,
  "tailwind": {
    "config": "apps/web/tailwind.config.js",
    "css": "apps/web/app/global.css",
    "baseColor": "stone",
    "cssVariables": true
  },
  "aliases": {
    "components": "@my-project/ui-components/components",
    "utils": "@my-project/ui-components/utils"
  }
}
```

add `tsconfig.json` at root for shadcn/ui cli
```json
{
  "compilerOptions": {
    "baseUrl": ".",
    "paths": {
      "@my-project/ui-components": ["libs/ui-components/src/index.ts"],
      "@my-project/ui-components/*": ["libs/ui-components/src/*"]
    }
  }
}
```

We can use shadcn/ui cli to install compoenent

https://ui.shadcn.com/docs/components/dropdown-menu

`npx shadcn-ui@latest add dropdown-menu`

export our component from library (export from `libs/ui-components/src/index.ts`)

edit `cn` import in generated component
```ts
import { cn } from "../../utils"
```

add the component to the root `page.tsx` at `apps/web`
```tsx
<DropdownMenu>
  <DropdownMenuTrigger>Open</DropdownMenuTrigger>
  <DropdownMenuContent>
    <DropdownMenuLabel>My Account</DropdownMenuLabel>
    <DropdownMenuSeparator />
    <DropdownMenuItem>Profile</DropdownMenuItem>
    <DropdownMenuItem>Billing</DropdownMenuItem>
    <DropdownMenuItem>Team</DropdownMenuItem>
    <DropdownMenuItem>Subscription</DropdownMenuItem>
  </DropdownMenuContent>
</DropdownMenu>
```

import compoennts from library (import `{ DropdownMenu } from '@my-project/ui-components';`)

restart web app (`nx serve web`)

shadcn-nx-nextjs-boilerplate

shadcn-nx-nextjs-boilerplate Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

shadcn-nx-nextjs-boilerplate

shadcn-nx-nextjs-boilerplate Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README