Skip to content

Latest commit

 

History

History
74 lines (59 loc) · 2.91 KB

README.md

File metadata and controls

74 lines (59 loc) · 2.91 KB
Raw

SPA Starter Kit Monorepo

The SPA starter kit contains:

It's designed to enable users to create their own starter applications and, in the future, will support additional frameworks.

The monorepo is set up using PNPM workspaces.

Getting Started

  1. Install PNPM:
npm i pnpm -g
  1. Install all the dependencies of the monorepo and build the SPA:
npm run install-build:<your-spa-app>
  1. [Optional] After making changes, re-build your SPA:
npm run build:<your-spa-app>
  1. Start the SPA in production mode:
npm run start:<your-spa-app>

<your-spa-app> - your SPA application. Currently the only availble framework is Angular.

Deployment

  1. Create your repository based on this one.
  2. The default configuration deploys the Next.js application. To deploy your SPA + Proxy instead, you need to enable the relevant rendering host in xmcloud.build.json and disable the nextjsstarter rendering host. The following example is for an Angular SPA:
    "renderingHosts": {
        "nextjsstarter": {
            ...
            "enabled": false,
            ...
        },
        "angularstarter": {
            ...
            "enabled": true,
            ...
        }
    },
  1. Push the updates.
  2. Log into the XM Cloud Deploy app, create a project and a deployment using your code and select your repository.
  3. After the deployment finishes succesfully, create a site and a page. You should now be able to see your the new page in Pages.

Local development against the XM Cloud instance

  1. Log into the Deploy app, locate your Environment and select the Developer Settings tab.
  2. Ensure that the context switch is set to Preview.
  3. In the Local Development** section, click to copy the sample .env` file contents to your clipboard.
  4. Open the .env file in the ./headapps/spa-starters/<your-spa-app> folder and paste everything except JSS_EDITING_SECRET.
  5. From the Local Development section copy the value of the JSS_EDITING_SECRET variable and paste it into the .env file of the proxy app ./headapps/spa-starters/proxy
  6. Run the following commands in the root of the repository to start your SPA application:
cd headapps/spa-starters
pnpm build:<your-spa-app>
pnpm start:<your-spa-app>
  1. Make sure you can access your site on http://localhost:3000
  2. You can also connect your local host to Pages to use it as editing host.

Running your SPA + Proxy in local containers is not supported, since SPA + Proxy does not support Experience Editor, and the instructions above cover all development flow use cases.