Skip to main content
Skip table of contents

Template CRA

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

Template

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

CODE
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
 start

Copy

(yarn create is available in Yarn 0.25+)

npm/npx

CODE
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
 start

Copy

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

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.