1. SuiteCloud Platform
  2. SuiteScript
  3. SuiteScript Developer Guide
  4. Single Page Applications
  5. Introduction to Single Page Applications
  6. Components and Structure of Single Page Applications
  7. Sample SuiteCloud Project Structure for a Single Page Application

Sample SuiteCloud Project Structure for a Single Page Application

The following examples show the local project structures for a SuiteApp and an account customization project (ACP). They reflect the structures after you run the build and bundle tasks in the gulpfile.mjs files from the sample SPA projects. In the SuiteApp example, <ApplicationId> represents the application ID. In the ACP example, <ProjectFolder> represents the local project root directory.

For more information about each project structure, see the following:

SuiteApp Project Structure

            <ApplicationId>
├── build/
├── node_modules/ 
├── src/
│   ├── FileCabinet/
│         ├── SuiteApps/<ApplicationId>/
│               ├── <OtherScripts>/
│               ├── <SpaFolder>/
│                    ├── assets/
│                    ├── SpaClient.js
│                    └── SpaServer.js
│         └── Web Site Hosting Files/
│   ├── InstallationPreferences/
│   ├── Objects/
│         └── custspa_helloworld.xml
│   ├── SuiteApps/<ApplicationId>/
│         ├── <SpaFolder>/
│               ├── assets/
│               ├── HelloWorld.tsx
│               ├── SpaClient.tsx
│               └── SpaServer.tsx
│   ├── Translations/
│   ├── deploy.xml
│   └── manifest.xml
├── test/
├── gulpfile.mjs
├── jest.config.js
├── package.json
├── suitecloud.config.js
├── tsconfig.json
└── tsconfig.test.json

Account Customization Project Structure

            <ProjectFolder>
├── build/
├── node_modules/
├── src/
│   ├── FileCabinet/
│   │   └── SuiteScripts/
│   │       └── <SpaFolder>/
│   │           ├── assets/
│   │           ├── SpaClient.js
│   │           └── SpaServer.js
│   ├── Objects/
│   │   └── custspa_helloworld.xml
│   ├── SuiteScripts/
│   │   └── <SpaFolder>/
│   │       ├── assets/
│   │       ├── HelloWorld.tsx
│   │       ├── SpaClient.tsx
│   │       └── SpaServer.ts
│   ├── deploy.xml
│   └── manifest.xml
├── test/
├── gulpfile.mjs
├── jest.config.mjs
├── package.json
├── suitecloud.config.js
├── tsconfig.json
└── tsconfig.test.json

Related Topics

General Notices