Projektstruktur und Organisation

Diese Seite bietet einen Überblick über alle Ordner- und Dateikonventionen in Next.js sowie Empfehlungen zur Organisation Ihres Projekts.

Ordner- und Dateikonventionen

Top-Level-Ordner

Top-Level-Ordner dienen der Organisation Ihres Anwendungscodes und statischer Assets.

Route-Segmente zu Pfadsegmenten
appApp Router
pagesPages Router
publicStatische Assets für den Einsatz
srcOptionaler Quellordner der Anwendung

Top-Level-Dateien

Top-Level-Dateien werden zur Konfiguration Ihrer Anwendung, Verwaltung von Abhängigkeiten, Ausführung von Middleware, Integration von Monitoring-Tools und Definition von Umgebungsvariablen verwendet.

Next.js
next.config.jsKonfigurationsdatei für Next.js
package.jsonProjektabhängigkeiten und Skripte
instrumentation.tsOpenTelemetry- und Instrumentationsdatei
middleware.tsNext.js-Request-Middleware
.envUmgebungsvariablen
.env.localLokale Umgebungsvariablen
.env.productionProduktions-Umgebungsvariablen
.env.developmentEntwicklungs-Umgebungsvariablen
.eslintrc.jsonKonfigurationsdatei für ESLint
.gitignoreGit-Dateien und -Ordner zum Ignorieren
next-env.d.tsTypeScript-Deklarationsdatei für Next.js
tsconfig.jsonKonfigurationsdatei für TypeScript
jsconfig.jsonKonfigurationsdatei für JavaScript

Dateikonventionen

_app.js .jsx .tsxBenutzerdefinierte App
_document.js .jsx .tsxBenutzerdefiniertes Dokument
_error.js .jsx .tsxBenutzerdefinierte Fehlerseite
404.js .jsx .tsx404-Fehlerseite
500.js .jsx .tsx500-Fehlerseite

Routen

Ordnerkonvention
index.js .jsx .tsxStartseite
folder/index.js .jsx .tsxVerschachtelte Seite
Dateikonvention
index.js .jsx .tsxStartseite
file.js .jsx .tsxVerschachtelte Seite

Dynamische Routen

Ordnerkonvention
[folder]/index.js .jsx .tsxDynamisches Routensegment
[...folder]/index.js .jsx .tsxCatch-all-Routensegment
[[...folder]]/index.js .jsx .tsxOptionales Catch-all-Routensegment
Dateikonvention
[file].js .jsx .tsxDynamisches Routensegment
[...file].js .jsx .tsxCatch-all-Routensegment
[[...file]].js .jsx .tsxOptionales Catch-all-Routensegment