Next.js 实战 (一)：项目搭建指南

前言

时间过得好快，一下就来到2024下半年了。

上半年我为了学习 Nuxt3，从 0 到 1 开发了一个导航网站：Dream Site，目前主要的功能都已完成了，后续有时间再慢慢添加有趣的功能。

下半年开始进攻 Next.js，前段时间我使用 Next.js 重构了一个项目：今日热榜，对 Next.js 有一定的认识，这次打算完整地从 0 到 1 搭建一个后台模板，进而探索 Next.js 的奥秘。

项目搭建

官方建议使用 create-next-app 启动一个新的 Next.js 应用程序：

npx create-next-app@latest

安装时，你将看到以下提示：

What is your project named? my-app
Would you like to use TypeScript? No / Yes
Would you like to use ESLint? No / Yes
Would you like to use Tailwind CSS? No / Yes
Would you like to use `src/` directory? No / Yes
Would you like to use App Router? (recommended) No / Yes
Would you like to customize the default import alias (@/*)? No / Yes
What import alias would you like configured? @/*

Next.js现在默认附带 TypeScript、ESLint 和 Tailwind CSS 配置。

项目运行

pnpm dev

目录结构

📄 next.config.js // Next.js的配置文件
📄 package.json // 项目依赖项和脚本
📄 instrumentation.ts // OpenTelemetry and Instrumentation 文件
📄 middleware.ts // Next.js请求中间件
📄 .env // Environment variables 环境变量
📄 .env.local // 局部环境变量
📄 .env.production // 生产环境变量
📄 .env.development // 开发环境变量
📄 .eslintrc.json // ESLint 的配置文件
📄 .gitignore // 要忽略的 Git 文件和文件夹
📄 next-env.d.ts // 用于 Next.js 的 TypeScript 声明文件
📄 tsconfig.json // TypeScript 的配置文件
📄 jsconfig.json // JavaScript 的配置文件

APP 路由约定

📄 layout[.js,.jsx,.ts] // Layout 布局
📄 page[.js,.jsx,.ts] // Page 页
📄 loading[.js,.jsx,.ts] // Loading UI 加载 UI
📄 not-found[.js,.jsx,.ts] // Not found UI 未找到 UI
📄 error[.js,.jsx,.ts] // Error UI 错误 UI
📄 global-error[.js,.jsx,.ts] // Global error UI 全局错误 UI
📄 route[.js,.ts] // API endpoint API 端点
📄 template[.js,.jsx,.ts] // Re-rendered layout 重新渲染的布局
📄 default[.js,.jsx,.ts] // 并行路由回退页面

更多约定请参考：App Routing Conventions

开发规范

这些配置在以前的文章写过，就不重复了，需要的可以参考下

配置 Eslint、Prettierrc、Husky等项目提交规范
使用 release-it 自动管理版本号和生成 CHANGELOG
使用 sort-imports 排序规则美化头部 import 代码

安装 NextUI

pnpm add @nextui-org/react framer-motion

新建 .npmrc 文件，并写入以下内容

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

tailwind.config.js 配置文件添加代码：

 import { nextui } from '@nextui-org/react';
 import type { Config } from 'tailwindcss';

 const config: Config = {
   darkMode: 'class',
   content: [
     './node_modules/@nextui-org/theme/dist/**/*.{js,ts,jsx,tsx}',
   ],
   theme: {
     extend: {}
   },
   plugins: [nextui()],
 };
 export default config;

在根节点添加 NextUIProvider

 import './globals.scss';

 import { NextUIProvider } from '@nextui-org/react';
 import type { Metadata } from 'next';
 import { Inter } from 'next/font/google';

 const inter = Inter({ subsets: ['latin'] });

 export const metadata: Metadata = {
   title: 'next-admin',
   description: '基于 Next.js 开发的后台模板',
 };

 export default function RootLayout({
   children,
 }: Readonly<{
   children: React.ReactNode;
 }>) {
   return (
     <html lang="zh-cn">
       <body className={inter.className}>
         <NextUIProvider>{children}</NextUIProvider>
       </body>
     </html>
   );
 }