Skip to content

Latest commit

 

History

History
88 lines (60 loc) · 2.93 KB

QUICKSTART.md

File metadata and controls

88 lines (60 loc) · 2.93 KB
Raw

Quick Start

This guide covers how you can quickly get started using Warehouse.

This guide does not cover how to deploy and secure Warehouse on your own infrastructure.

Prerequisites

The following prerequisites are required for a successful use of Warehouse.

  • Warehouse service running and accessible via http
  • Warehouse CLI installed

Configuring the CLI

Warehouse CLI will look for a .wrhs config file in the root user directory. Alternatively, you can specify a different path to the config file using the WRHS_NEXT_CONFIG environment variable.

In your config, you must declare the warehouse service endpoint and authentication credentials.

The config file uses a JSON-like syntax:

{
  "baseUrl": "https://wrhs.mydomain.com",
  "username": "user",
  "password": "password"
}

Push an asset to Warehouse

In this example we assume that we have an application call example-app that uses Warehouse to store and distrubute its assets. The application has two assets called script.js and style.css, and it runs in three separate environemnts: development, test and production. The app has only one locale: en-US. The assets for each environments are compiled with different parameters, therefore each environment references to different CDN files (files in different environments have different fingerprint).

Our application assets can be compiled with the NODE_ENV=<env> npm run build command where <env> is the environment for which the assets are getting builded for.

Now let's assume we want to publish version 1.0.0 of the application in development.

We start with building the assets:

NODE_ENV=dev npm run build

Then we can push the assets to Warehouse using the CLI:

# Upload and register assets
wrhs upload /example-app/dist example-app --env development --version 1.0.0 --variant en-US

# Set version 1.0.0 as current
wrhs object set-head example-app --env development --version 1.0.0

Now the application backend can call Warehouse API to obtain:

  1. The current app version
  2. The asset urls
const { Request } = require('@wrhs/utils');

const { NODE_ENV, WRHS_ENDPOINT, WRHS_USERNAME, WRHS_PASSWORD } = process.env;

const wrhs = new Request({
  baseUrl: WRHS_ENDPOINT,
  username: WRHS_USERNAME,
  password: WRHS_PASSWORD
});

(async function () {
  // headVersion is '1.0.0'
  const { headVersion } = await wrhs.get(`/head/example-app/${NODE_ENV}`);

  const [variant] = await wrhs.get('/objects/example-app', {
    accepted_variants: 'en-US',
    env: NODE_ENV,
    version: headVersion
  });

  for (const file of variant.data.files) {
    // https://mycdn.com/71fbac4eca64da6727d4a9c9cd00e353/script.js
    // https://mycdn.com/574d0c0f86b220913f60ee7aae20ec6a/style.css
    console.log(file.url);
  }
})();

Finally, whenever version 1.0.0 is ready to go test and/or production, simply repeat the previous steps changing the environment parameter.