runbook.md

Runbook for Spine Datasheet

Prerequisites

• .NET 6.0+
• Node 16+ with npm 8+
• Docker

Run backend

Run backend from spinedatasheetapi repo.

Create a file backend/api/Properties/launchSettings.json with the provided template file. You need to populate the app configuration connection string (navigate to azure portal, find app configuration resource, navigate to settings -> access keys), and choose an AppConfiguration Environment (dev for local development at time of writing).

Finally, to be able to use secrets referenced in the app config, you need to authenticate yourself on the command line. Get a hold of the azure CLI az and run az login in the command line. NB: You will need to use a browser for the authentication, as far as I know.

Then, to start the backend, you can run

cd datasheetapi
dotnet run

Run frontend

Run frontend from spinedatasheetweb repo.

yarn install
yarn start

Deployment

We have 3 different environments in use; dev, qa and prod. Dev is built when pull requests are merged to main.