repox/getcandy-hub repository overview

ALPHA BUILD

Docker image for starting a local development version the GetCandy Administration Hub⁠.

⁠Usage

This image will install the hub in the mounted directory attached to /srv/hub in the Docker container. It will check if the Admin Hub repository⁠ exists in that location. If not, a checkout will automatically be done and NPM packages will be installed.

Finally, yarn dev will run and be exposed at port 3000 in the container. The example below will map port 3000 to the host as well, making the Admin Hub available at `http://localhost:3000/⁠ when the project server has started.

NB First run will take quite some time, if you're not mapping to an existing checkout of the Administration Hub.

Example usage:

docker run \
    -it --rm -p 3000:3000 \
    -v $(pwd):/srv \
    -e 'API_BASE=http://storefront-api.test/api/v1' \
    -e 'API_HOST=http://storefront-api.test' \
    -e 'AUTH_LOGIN_ENDPOINT=http://storefront-api.test/api/login' \
    -e 'AUTH_LOGOUT_ENDPOINT=http://storefront-api.test/api/logout' \
    -e 'AUTH_USER_ENDPOINT=http://storefront-api.test/api/v1/users/current' \
    -e 'PRODUCT_PREVIEW_URL=http://storefront.test/products/preview/:id' \
    -e 'CATEGORY_PREVIEW_URL=http://storefront.test/categories/preview/:id' \
    -e 'COLLECTION_PREVIEW_URL=http://storefront.test/collections/preview/:id' \
    repox/getcandy-hub:alpha

All environment variables shown in the example above are stated with their default values. If the environment variable isn't overwritten, those variables are the default values.