Getting-Started.md

Getting Started

The following instructions describe how to build and deploy this software.

Preparation

Set up the external dependencies before proceeding.

Once packages are installed, run yarn start to launch the client on a development server at http://localhost:3000.

To build for release, simply run yarn build. The output will be written to a build directory. Instructions on how to serve the build will be provided at this point.

ESLint and Prettier can be run using yarn lint. If you wish to list the warnings without writing changes yarn lint-check can be used instead.

Run as a Docker container

At this point in time, a prebuilt container is not provided. Luckily it is easy to build it from source! You will need to have git installed as well as Docker.

git clone https://github.com/sony/nmos-js
cd nmos-js
docker build -t nmos-js Development

Start the Docker container by binding nmos-js to an external port.

docker run -d --name=nmos-js -p 80:80 nmos-js