Nuxt project structure in Vue

Introduction

Nuxt project structure helps organize your app files clearly. It makes building and maintaining your Vue app easier.

When starting a new Nuxt app to keep code organized

When adding pages or components to your Nuxt app

When you want to use Nuxt features like routing and layouts automatically

When working with a team to keep everyone on the same page

When deploying your Nuxt app and need a clear folder setup

Syntax

Vue

nuxt-project/
├── assets/
├── components/
├── composables/
├── layouts/
├── middleware/
├── pages/
├── plugins/
├── public/
├── server/
├── stores/
├── nuxt.config.ts
├── package.json

assets/ holds images, styles, and fonts you want to process.

pages/ auto-creates routes based on Vue files inside.

Examples

This creates routes: /, /about, and dynamic /blog/:id

Vue

pages/
  ├── index.vue
  ├── about.vue
  └── blog/
      └── [id].vue

Layouts wrap pages with common structure like headers or footers.

Vue

layouts/
  ├── default.vue
  └── admin.vue

Reusable UI parts used inside pages or layouts.

Vue

components/
  ├── Navbar.vue
  └── Footer.vue

Code to add global features or libraries before app starts.

Vue

plugins/
  └── axios.ts

Sample Program

This simple Nuxt project has a logo image, a reusable HelloWorld component, a default layout, and two pages: home and about.

Vue

nuxt-project/
├── assets/
│   └── logo.png
├── components/
│   └── HelloWorld.vue
├── layouts/
│   └── default.vue
├── pages/
│   ├── index.vue
│   └── about.vue
├── nuxt.config.ts
└── package.json

Important Notes

Folders like pages and layouts have special meaning in Nuxt.

Use components for reusable parts, not pages.

Keep nuxt.config.ts at the root to configure your app.

Summary

Nuxt project structure organizes your app into clear folders.

Pages folder auto-creates routes for your app.

Layouts wrap pages with common UI parts like headers.

Practice

1. In a Nuxt project, which folder automatically generates routes based on its files?

easy

A. pages folder

B. components folder

C. layouts folder

D. plugins folder

Solution

1. Step 1: Understand Nuxt routing

   Nuxt uses the pages folder to create routes automatically from the files inside it.

2. Step 2: Identify folder roles

   components holds reusable UI parts, layouts define page wrappers, and plugins add extra functionality, but none auto-generate routes.

3. Final Answer:

   pages folder -> Option A

4. Quick Check:

   Routes come from pages folder [OK]

Hint: Routes come from the pages folder files [OK]

Common Mistakes:

• Confusing components folder with pages
• Thinking layouts create routes
• Assuming plugins handle routing

2. Which of the following is the correct way to define a layout in a Nuxt project?

easy

A. Add a Vue component inside pages/ folder named layout.vue

B. Create a file in layouts/ folder and export a Vue component

C. Place a JavaScript file in plugins/ folder named layout.js

D. Create a CSS file in assets/ folder named layout.css

Solution

1. Step 1: Know where layouts go

   Layouts in Nuxt are Vue components placed inside the layouts/ folder to wrap pages.

2. Step 2: Check other options

   Pages folder is for routes, plugins are for JS extensions, assets hold styles or images, so these are incorrect for layouts.

3. Final Answer:

   Create a file in layouts/ folder and export a Vue component -> Option B

4. Quick Check:

   Layouts live in layouts folder [OK]

Hint: Layouts are Vue files inside layouts folder [OK]

Common Mistakes:

• Putting layouts inside pages folder
• Confusing plugins with layouts
• Thinking CSS files define layouts

3. Given this Nuxt project structure:

layouts/default.vue
pages/index.vue
pages/about.vue

What happens when you visit the URL /about?

medium

A. The default.vue layout is shown alone without any page

B. The index.vue page is shown without any layout

C. A 404 error occurs because about.vue is not a layout

D. The about.vue page is shown wrapped by default.vue layout

Solution

1. Step 1: Understand routing and layouts

   Visiting /about loads pages/about.vue automatically as a route.

2. Step 2: Layout wrapping behavior

   By default, pages are wrapped inside the layouts/default.vue layout unless specified otherwise.

3. Final Answer:

   The about.vue page is shown wrapped by default.vue layout -> Option D

4. Quick Check:

   Page loads with default layout [OK]

Hint: Pages load inside default layout unless changed [OK]

Common Mistakes:

• Thinking about.vue is not a route
• Assuming layouts show alone
• Ignoring default layout wrapping

4. You created a file pages/contact.vue but visiting /contact shows a 404 error. What is the most likely cause?

medium

A. The plugins/ folder is empty

B. The layouts/default.vue file is missing

C. The contact.vue file is inside components/ folder instead of pages/

D. You forgot to import contact.vue in pages/index.vue

Solution

1. Step 1: Check file location for routing

   Nuxt auto-generates routes only from files inside the pages/ folder.

2. Step 2: Identify common mistakes

   If contact.vue is inside components/, it won't create a route, causing 404 on /contact.

3. Final Answer:

   The contact.vue file is inside components/ folder instead of pages/ -> Option C

4. Quick Check:

   Pages folder files create routes [OK]

Hint: Pages must be inside pages folder for routing [OK]

Common Mistakes:

• Placing pages in components folder
• Thinking layouts cause 404
• Assuming imports needed for pages

5. You want to create a Nuxt app with two different page layouts: one for public pages and one for admin pages. How should you organize your project structure to achieve this?

hard

A. Create layouts/public.vue and layouts/admin.vue, then specify layout in each page's definePageMeta

B. Put all pages in pages/ and import layouts manually inside each page component

C. Create two separate pages/ folders named public and admin without layouts

D. Use plugins/ to switch layouts dynamically based on route

Solution

1. Step 1: Understand layout usage in Nuxt

   You can create multiple layouts inside layouts/ folder, each as a Vue component.

2. Step 2: Assign layouts per page

   Use definePageMeta in each page to specify which layout to use, e.g., layout: 'admin' or layout: 'public'.

3. Step 3: Evaluate other options

   Importing layouts manually or using plugins for layout switching is not the recommended Nuxt pattern.

4. Final Answer:

   Create layouts/public.vue and layouts/admin.vue, then specify layout in each page's definePageMeta -> Option A

5. Quick Check:

   Multiple layouts + definePageMeta = correct [OK]

Hint: Use multiple layouts and definePageMeta per page [OK]

Common Mistakes:

• Trying to import layouts manually in pages
• Not using definePageMeta for layout selection
• Misusing plugins for layout switching