@dxos/esapp

Look in the src/example directory.

Usage no npm install needed!

<script type="module">
  import dxosEsapp from 'https://cdn.skypack.dev/@dxos/esapp';
</script>

README

ESApp - amazingly fast dev-server built with esbuild

Getting started

Look in the src/example directory.

CLI reference

esapp <command>

Commands:
  esapp dev                start the dev server
  esapp book <stories...>  start the dev server with a book of components

Options:
  --help     Show help                                                 [boolean]
  --version  Show version number  

Config file

Config is automatically loaded from ./esapp.config.js.

export interface Config {
  /**
   * List of entry points to bundle.
   * 
   * Those are then can be requested from the dev server.
   * 
   * Read more: https://esbuild.github.io/api/#entry-points
   */
  entryPoints?: string[] | Record<string, string>

  /**
   * Directory with static files to be served by the dev server.
   */
  staticDir?: string

  /**
   * Esbuild plugins: https://esbuild.github.io/plugins/.
   */
  plugins?: Plugin[]
}

Storybook

ESApp's stories are compatible with storybook format, although only the very minimal features are supported.

To render a storybook run the following command (replacing with your glob for stories).

esapp book 'stories/**/*.stories.tsx'

Each story file should export a set of components and optionally a default export with the title that will be displayed in the outline.

Development

Use yarn link and yarn build --watch to use the development build of this project from another package.

Polyfills

Currently ESApp does not polyfill any of the node.js modules or globals. If your code is using them you'd need to manually include a plugin to add them.