On this page

Project Structure

This page provides an overview of the file and directory structure of a Pruvious project.


Top-level directories

Although most directories in the overview are inherited from the Nuxt framework, Pruvious introduces new directories and enhances some existing ones with new features. In the following list, these directories are marked with the P symbol and are linked in the Pruvious documentation. Other links lead to the external Nuxt documentation.

NameDescription

Nuxt uses this directory in development to generate your Vue application.

Nuxt creates this directory when building your application for production.

Pruvious uses this directory in development and production to generate dynamic imports.

The default directory for storing files uploaded through the CMS.

This directory is used for adding website assets that the build tool will process.

This directory contains special Vue components that facilitate the creation of page content with Pruvious.

A directory that contains all defined database collections.

This directory is used to store all Vue components that are are neither blocks nor icons.

Use this directory to auto-import your Vue composables into your application.

This directory contains Vue components that render custom pages for the dashboard.

Custom fields can be defined in this directory.

This directory contains definitions of asynchronous jobs that run at specified intervals.

A directory that contains page layouts.

Hooks are used to perform custom actions at specific stages during API operations.

Nuxt provides middleware to run code before navigating to a particular route.

Use this directory to automatically register local modules within your application.

The package manager stores the dependencies of your project in the this directory.

Nuxt provides file-based routing to create routes within your web application.

Nuxt has a plugins system to use Vue plugins and more at the creation of your Vue application.

The purpose of this directory is to serve the static assets for your website.

This directory is used to register API and server handlers to your application.

This directory contains defined translatable strings grouped by domains.

Use this directory to auto-import your utility functions throughout your application.

Top-level files

Just like in the directories overview above, you can spot Pruvious-specific files by looking for the symbol P. The rest of the files are inherited from the Nuxt framework.

NameDescription

This file specifies your build/dev-time environment variables.

A file that specifies intentionally untracked files that git should ignore.

This file allows you to ignore specific files in the root directory of your project during the build phase.

This file includes server information and deployment credentials for Pruvious CLI.

Exposes reactive configuration within your application.

The primary component of your website, which should include the <NuxtPage> component.

The main configuration file for your Nuxt app.

Contains all dependencies and scripts for your application.

The default SQLite database for your website.

Nuxt generates this file with sensible defaults and your aliases.

Learn more about Building your website.

Last updated on December 30, 2023 at 23:46