Skip to main content

Project structure

A new project generated with @archibald/create package contains following folders and files:

/
|-- .browserslistrc
|-- .gitignore
|-- .gitlab-ci.yml
|-- .npmrc
|-- .prettierignore
|-- .storybook
|-- README.md
|-- /dist
|-- /environment
|-- archibald.json
|-- eslint.config.mjs
|-- jest.config.ts
|-- package.json
|-- /src
|-- /shop
|-- /client
|-- /e2e
|-- /e2e-playwright
|-- /resources
|-- /server
|-- /service-worker
|-- tsconfig.json

Folders

  • /dist Automatically generated. This folder gets generated automatically by Archibald when serving or building the project. The files inside this folder are not meant for modification. Should be added to the .gitignore file if not added already.
  • /environment This folder contains project-specific configuration. Check out the project config for more detail.
  • /src This directory contains all of the code related to what you will see on the frontend of your site.
    • /shop Default platform folder.
      • /client This folder contains all client related code.
      • /e2e This folder contains Cypress end-to-end tests.
      • /e2e-playwright This folder contains Playwright end-to-end tests.
      • /resources This folder contains all static resources.
      • /server This folder contains all server related code.
      • /service-worker This folder contains all service-worker related code.
  • /.storybook This folder contains configuration necessary for running storybook.

Files

  • .browserslistrc Target browser configuration used by the build.
  • .gitlab-ci.yml CI pipeline configuration.
  • archibald.json Archibald configuration.
  • eslint.config.mjs ESLint configuration (flat config).
  • jest.config.ts Jest configuration.
  • tsconfig.json This file contains general Typescript configuration.