Skip to main content

Application Packages

Publishing and serving your application's client side assets is the main task Eik was designed for. Given local paths to client side bundle files you produce, Eik will package up the files and upload them to an Eik server where they will be served for use in your production applications.

Producing packages​

Use the publish command to package and upload local JavaScript and CSS bundle files to an Eik server from where they will be served.

eik.json definitions​

In your app's Eik config you use the files key to define a local path or paths to be included when publishing.

eik.json file entrypoints​

{
    "files": "./dist"
}

package.json file entrypoints​

{
    "eik": {
        "files": "./dist"
    }
}

The publish command​

With entrypoints defined in the Eik config, running the eik publish command will assemble files (specified by entrypoints) into an archive and upload the archive to the Eik server defined by the server field.

eik publish

Once uploaded, the archive will be unpacked and the files served at the appropriate paths.

The following example shows how entrypoint definitions correspond to final file locations:

Example.​

Given the following local files:

  • ./dist/index.js
  • ./dist/index.js.map
  • ./dist/ie11.js
  • ./dist/ie11.js.map
  • ./dist/index.css
  • ./dist/index.css.map

And the following eik.json definition:

{
    "server": "http://assets.myserver.com",
    "name": "my-pack",
    "version": "1.0.0",
    "files": "./dist"
}

Or the following package.json definition:

{
    "eik": {
        "name": "my-pack",
        "version": "1.0.0",
        "server": "http://assets.myserver.com",
        "files": "./dist"
    }
}

When running the following command:

eik publish

Then the published URLs will be:

  • http://assets.myserver.com/pkg/my-pack/1.0.0/index.js
  • http://assets.myserver.com/pkg/my-pack/1.0.0/index.js.map
  • http://assets.myserver.com/pkg/my-pack/1.0.0/ie11.js
  • http://assets.myserver.com/pkg/my-pack/1.0.0/ie11.js.map
  • http://assets.myserver.com/pkg/my-pack/1.0.0/index.css
  • http://assets.myserver.com/pkg/my-pack/1.0.0/index.css.map