Web site

The Web sites feature in the ComUnity Developer Toolkit allows developers to integrate static frontend sites directly into their project environment. It is designed to eventually replace the older ‘Custom Web’ interface, although both are currently supported.

Websites can be used to deploy lightweight frontends, custom tools, or portals like Community Central. Projects are created and managed entirely within the Toolkit and are accessible through a unique URL path.

Key Capabilities

  • Host static websites (HTML/CSS/JS/images/fonts) from within a project.

  • Built-in URL handler system for flexible routing.

  • Support for custom frontend apps or admin portals.

  • Access and preview your site via an autogenerated URL.

  • Optional download of project source code for local editing.

What Are Web Files?

Websites are composed of static files typically found in web development:

File Type
Purpose

index.html

Entry point of the site

.js files

Interactivity and logic

.css files

Styling and layout

.png, .svg

Images

.ttf, .woff2

Fonts

manifest.json

Metadata, PWS config (optional)

Accessing Your Website

https://<domain>/w/<app-name>/<url-suffix>

Where:

  • /w/ is the static web handler

  • <app-name> is your project identifier

  • <url-suffix> is defined when you create the website

Example

Handler Prefixes (Routing Conventions)

The platform uses dedicated handlers to route requests:

Handle

/p/

Polymer client

/o/

OData API access

/u/

Media upload/download

/d/

Direct file download (SHA)

/f/

Friendly filename downloads

/w/

Static website hosting

These handlers are not namespaces—they are internal URL routing tools (“handlers”) used by the platform to distinguish between services.

Creating a Web site

To create a Web site within your project, follow these steps:

  1. Open your project in the Toolkit and navigate to the Web sites section.

  2. Scroll to the section labelled Web sites (below the ComUnity Central tile).

  3. If you don’t already have any websites, you will see an action with the option to +Add web site.

  4. Click +Add web site to begin the setup process.

  5. In the dialog that appears, enter a URL suffix (e.g., myportal, tools, or games). This suffix will be used to generate the site’s unique URL: 

    https://toolkitv3.comunity.me/sw/<project-name>/<suffix>/

    Example URL: https://toolkitv3.comunity.me/sw/pokeman/games/index.html

    Segment
    Description

    https://toolkitv3.comunity.me

    Base domain of the Toolkit environment (e.g. QA or production).

    /sw/

    Static Web Handler – routes the request to a static website.

    pokeman

    Project name or app identifier – the name of your Toolkit project.

    games

    URL suffix defined when creating the website.

    index.html

    Default entry point – must be placed at the root level of uploaded files.

Future update will support setting a custom default file (e.g., home.html) and changing it post-creation.

Testing & Default Behaviour

  • The default document is index.html (must be at root level).

  • If improperly structured, the site may need to be re-created.

  • Auto-registration is active by default. This behaviour can be configured under:

    • Settings > Development Environment > Users & Roles > Credentials

    • Uncheck Disable Auto-Registration to force manual registration.

Last updated