This article describes the structure of a Wix CLI for Headless project created using the Blank Astro template. If you're using a different template, your file structure will contain different files, but the general structure will be the same.
A Wix CLI for Headless project is built on top of Astro, so it follows the standard Astro project structure with additional Wix-specific files and directories for extensions and configuration.
Note: Some of these files and directories don't exist when you initially create your project. They're created when you add extensions, and when you build or run your project.
Astro build and type files. Managed by Astro.
Contains configuration and log files related to the Wix environment.
Caution: This directory contains internal data. Don't edit it.
Contains the production build output of your project. This directory is created automatically when you build your project. You generally don't need to edit files here.
Static files served at the root of your site.
Source directory. Contains all the source code and core resources of your application.
A directory for storing static assets such as images and media files.
Reusable UI components for your frontend.
Contains your project's extensions. Each extension has its own subdirectory here. For more information, see About CLI Headless Extensions.
Layout components for your frontend.
Frontend route files for your site.
Astro configuration file.
Holds the environment variables for project. It initially holds the environmental variables required for authenticating your private app, which all have names beginning with WIX_CLIENT
. Don't edit any of the WIX_CLIENT
variables.
Holds various metadata relevant to the project. It manages the project's dependencies, scripts, and more.
Configuration for the TypeScript compiler.
Defines basic information about your project, including appId
of your private app, and projectId
of your headless project. Don't edit this file.