#Base Path

Base Path refers to the access path prefix for static resources (such as JavaScript, CSS, images, etc.) in an application. In Esmx, proper base path configuration is crucial for the following scenarios:

• Multi-Environment Deployment: Supports resource access in different environments like development, testing, and production.
• Multi-Region Deployment: Adapts to cluster deployment needs in different regions or countries.
• CDN Distribution: Achieves global distribution and acceleration of static resources.

#Default Path Mechanism

Esmx adopts an automatic path generation mechanism based on the service name. By default, the framework reads the name field in the project's package.json to generate the base path for static resources: /your-app-name/.

{
    "name": "your-app-name"
}

This convention-over-configuration design has the following advantages:

• Consistency: Ensures all static resources use unified access paths.
• Predictability: Resource access paths can be inferred through the name field in package.json.
• Maintainability: No additional configuration needed, reducing maintenance costs.

#Dynamic Path Configuration

In real-world projects, we often need to deploy the same codebase to different environments or regions. Esmx provides support for dynamic base paths, enabling applications to adapt to various deployment scenarios.

#Usage Scenarios

#Secondary Directory Deployment

- example.com      -> Default main site
- example.com/cn/  -> Chinese site
- example.com/en/  -> English site

#Independent Domain Deployment

- example.com    -> Default main site
- cn.example.com -> Chinese site
- en.example.com -> English site

#Configuration Method

You can dynamically set the base path based on the request context through the base parameter of the esmx.render() method:

const rc = await esmx.render({
    base: '/cn',
    params: {
        url: req.url
    }
});

#Best Practices

• In production environments, it is recommended to dynamically determine the base path through environment variables or request headers to avoid hardcoding.
• When using a CDN, ensure that the base path points to the CDN domain to fully leverage caching and acceleration capabilities.
• Multi-language sites can be distinguished by secondary directories (such as /cn/, /en/) or independent domains. Choose the appropriate solution based on business requirements.