Getting started

File structure

Cartzilla

This is the root template folder that contains all project files.

public

This folder contains static assets that are served directly at the root path.

public / app-icons

This folder contains favicon images optimized for different browsers and platforms.

public / data

This folder contains static JSON data files used throughout the application.

public / img

This folder contains all the template's graphic assets, including images and illustrations, organized within subfolders.

scripts

This folder contains utility scripts used by the build process.

scripts / icon-font.mjs

This script handles the generation of icon fonts from SVG files.

scripts / logger.mjs

This script provides logging utilities for other build scripts.

src

This folder contains the source code for the Next.js application.

src / app

This is the main directory for the Next.js App Router. It contains all the page routes and application files.

src / app / (routes)

These folders (404, about, account, blog, contact, docs, help, home, etc.) represent different routes and pages in the application.

src / app / layout.tsx

The root layout component that wraps all pages and provides common UI elements.

src / app / page.tsx

The main page component rendered at the root URL of the application.

src / app / navigation.tsx

Contains the main navigation components for the application.

src / app / not-found.tsx

Custom 404 page component displayed when a route doesn't exist.

src / app / manifest.ts

Defines the Progressive Web App (PWA) manifest for the application.

src / components

Contains reusable React components used throughout the application.

src / contexts

Contains React context providers for state management.

src / hooks

Contains custom React hooks for reusable logic.

src / icons

Contains SVG icon components and icon-related utilities.

src / lib

Contains utility functions and helper libraries.

src / styles

Contains all project SCSS files and style-related configurations.

src / types

Contains TypeScript type definitions and interfaces.

.editorconfig

Configuration file for maintaining consistent coding styles across different editors and IDEs.

.eslintrc.json

Configuration file for ESLint to enforce code quality and style rules.

.gitignore

Specifies files and directories that should be ignored by Git.

.prettierignore

Specifies files and directories that should be ignored by Prettier code formatter.

.prettierrc

Configuration file for Prettier code formatter.

.stylelintignore

Specifies files and directories that should be ignored by Stylelint.

.stylelintrc.json

Configuration file for Stylelint to enforce CSS/SCSS style rules.

next-env.d.ts

TypeScript declaration file for Next.js, providing type information for Next.js specific features.

next.config.mjs

Configuration file for Next.js, allowing customization of the build process, webpack configuration, and more.

package-lock.json

Auto-generated file that locks down the versions of dependencies installed.

package.json

Contains metadata about the project and lists its dependencies, as well as scripts for building and starting the application.

README.md

Markdown file containing information about the project, setup instructions, and other documentation.

tsconfig.json

Configuration file for TypeScript compiler options and project settings.

Top