Skip to content

Getting Started

Andre Gagnon edited this page Nov 30, 2022 · 9 revisions

To get started, run:

composer install

yarn

Next run:

yarn bootstrap

You will be prompted for your local development url. Please enter this to match the local dev environment you are using. This will install any dependencies and create a wpackio.server.js file with your development environment settings.

Here's an example of a wpackio.server.js file using Laravel Valet:

module.exports = {
  // Your LAN IP or host where you would want the live server
  // Override this if you know your correct external IP (LAN)
  // Otherwise, the system will always use localhost and will not
  // work for external IP.
  // This will also create some issues with file watching because for
  // some reason, service-worker doesn't work on localhost?
  // https://github.com/BrowserSync/browser-sync/issues/1295
  // So it is recommended to change this to your LAN IP.
  // If you intend to access it from your LAN (probably do?)
  // If you keep null, then wpackio-scripts will try to determine your LAN IP
  // on it's own, which might not always be satisfying. But it is in most cases.
  host: undefined,
  // Your WordPress development server address
  // This is super important
  proxy: "https://presto.test",
  // PORT on your localhost where you would want live server to hook
  port: 5678,
  // UI passed directly to browsersync
  ui: {
    port: 3001,
  },
  // Whether to show the "BrowserSync Connected"
  notify: false,
  // Open the local URL, set to false to disable
  open: true,
  // BrowserSync ghostMode, set to false to completely disable
  ghostMode: {
    clicks: true,
    scroll: true,
    forms: true,
  },
  // Override system calculated public path of the `dist` directory
  // This must have forward slash, otherwise it will not work.
  distPublicPath: undefined,

  // allow ssl certifications in proxy.
  bsOverride: {
    https: {
      key: "/Users/andre/.config/valet/Certificates/presto.test.key",
      cert: "/Users/andre/.config/valet/Certificates/presto.test.crt",
    },
  },
};

Then you can start the development build and server using:

yarn start

Clone this wiki locally