https://github.com/nextui-org/next-app-template

A Next.js 13 with app directory template pre-configured with NextUI (v2) and Tailwind CSS.
https://github.com/nextui-org/next-app-template

nextjs nextjs-template nextjs13 nextui template

Last synced: about 2 months ago
JSON representation

A Next.js 13 with app directory template pre-configured with NextUI (v2) and Tailwind CSS.

• Host: GitHub
• URL: https://github.com/nextui-org/next-app-template
• Owner: nextui-org
• License: mit
• Created: 2023-06-02T01:34:33.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-03-04T13:07:37.000Z (7 months ago)
• Last Synced: 2024-04-14T04:22:46.339Z (5 months ago)
• Topics: nextjs, nextjs-template, nextjs13, nextui, template
• Language: TypeScript
• Homepage: https://nextui-app.vercel.app
• Size: 424 KB
• Stars: 220
• Watchers: 6
• Forks: 51
• Open Issues: 11
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-ccamel - nextui-org/next-app-template - A Next.js 14 with app directory template pre-configured with NextUI (v2) and Tailwind CSS. (TypeScript)

README

        
# Next.js & NextUI Template

This is a template for creating applications using Next.js 14 (app directory) and NextUI (v2).

[Try it on CodeSandbox](https://githubbox.com/nextui-org/next-app-template)

## Technologies Used

- [Next.js 14](https://nextjs.org/docs/getting-started)

- [NextUI v2](https://nextui.org/)

- [Tailwind CSS](https://tailwindcss.com/)

- [Tailwind Variants](https://tailwind-variants.org)

- [TypeScript](https://www.typescriptlang.org/)

- [Framer Motion](https://www.framer.com/motion/)

- [next-themes](https://github.com/pacocoursey/next-themes)

## How to Use

### Use the template with create-next-app

To create a new project based on this template using `create-next-app`, run the following command:

```bash

npx create-next-app -e https://github.com/nextui-org/next-app-template

```

### Install dependencies

You can use one of them `npm`, `yarn`, `pnpm`, `bun`, Example using `npm`:

```bash

npm install

```

### Run the development server

```bash

npm run dev

```

### Setup pnpm (optional)

If you are using `pnpm`, you need to add the following code to your `.npmrc` file:

```bash

public-hoist-pattern[]=*@nextui-org/*

```

After modifying the `.npmrc` file, you need to run `pnpm install` again to ensure that the dependencies are installed correctly.

## License

Licensed under the [MIT license](https://github.com/nextui-org/next-app-template/blob/main/LICENSE).