mirror of
https://github.com/hanzoai/next.js.git
synced 2026-10-30 14:46:38 +00:00
78e7ddd0f2
Small update to mention TS paths when changing to src/ directory as it is something most users will need to do. Co-authored-by: Sam Ko <[email protected]>
35 lines
2.0 KiB
Plaintext
35 lines
2.0 KiB
Plaintext
---
|
|
title: src Directory
|
|
description: Save pages under the `src` directory as an alternative to the root `pages` directory.
|
|
related:
|
|
links:
|
|
- app/building-your-application/routing/colocation
|
|
---
|
|
|
|
{/* The content of this doc is shared between the app and pages router. You can use the `<PagesOnly>Content</PagesOnly>` component to add content that is specific to the Pages Router. Any shared content should not be wrapped in a component. */}
|
|
|
|
As an alternative to having the special Next.js `app` or `pages` directories in the root of your project, Next.js also supports the common pattern of placing application code under the `src` directory.
|
|
|
|
This separates application code from project configuration files which mostly live in the root of a project, which is preferred by some individuals and teams.
|
|
|
|
To use the `src` directory, move the `app` Router folder or `pages` Router folder to `src/app` or `src/pages` respectively.
|
|
|
|
<Image
|
|
alt="An example folder structure with the `src` directory"
|
|
srcLight="/docs/light/project-organization-src-directory.png"
|
|
srcDark="/docs/dark/project-organization-src-directory.png"
|
|
width="1600"
|
|
height="687"
|
|
/>
|
|
|
|
> **Good to know**
|
|
>
|
|
> - The `/public` directory should remain in the root of your project.
|
|
> - Config files like `package.json`, `next.config.js` and `tsconfig.json` should remain in the root of your project.
|
|
> - `.env.*` files should remain in the root of your project.
|
|
> - `src/app` or `src/pages` will be ignored if `app` or `pages` are present in the root directory.
|
|
> - If you're using `src`, you'll probably also move other application folders such as `/components` or `/lib`.
|
|
> - If you're using Middleware, ensure it is placed inside the `src` directory.
|
|
> - If you're using Tailwind CSS, you'll need to add the `/src` prefix to the `tailwind.config.js` file in the [content section](https://tailwindcss.com/docs/content-configuration).
|
|
> - If you are using TypeScript paths for imports such as `@/*`, you should update the `paths` object in `tsconfig.json` to include `src/`.
|