Template CRA [VDT IG]

The information on this page is sourced from here: Start Here / Template (CRA) - Page ⋅ Storybook (vidispine.github.io)

Introduction

We've created a Create React App template to help create react apps using vdt.

It is pre-configured with:

• Vdt packages and usage examples

• Linting/formatting based on vdt config packages

• Login/authentication (token-based) against a VidiCore instance

• Proxy to workaround browsers CORS restrictions (using http-proxy-middleware)

  • Note: CORS configuration can also be set in VidiCore

• Routing using React Router

• Styling using MUI

• General project structure with assets, components, pages and themes

Getting started

yarn

yarn create react-app my-vdt-app --template @vidispine/vdt@latest
# or "@next" for latest pre-release
cd my-vdt-app
REACT_APP_VIDISPINE_URL=https://example.myvidispine.com yarn startCopy

(yarn create is available in Yarn 0.25+)

npm/npx

npx create-react-app my-vdt-app --template @vidispine/vdt@latest
# or "@next" for latest pre-release
cd my-vdt-app
REACT_APP_VIDISPINE_URL=https://example.myvidispine.com npm startCopy

(npx comes with npm 5.2+ and higher, see instructions for older npm versions)