Skip to content

local-development.md

Latest commit

 

History

History
46 lines (30 loc) · 1.33 KB

local-development.md

File metadata and controls

46 lines (30 loc) · 1.33 KB
Raw

Local Development

Installation

VSCode Dev Containers

If you have VScode and Docker, the remaining dependencies are baked into the development container environment.

  • Follow the installation instructions for the Dev Containers extension
  • Open the repository folder in VSCode
  • Choose "Reopen in Container" via the command palette or in the left window pane when selecting the Remote Explorer extension
  • Select the Node.js 20.x Container

Once the development container is running, you should be able to run any of the commands defined in the package.json successfully.

Linux

curl -sL https://deb.nodesource.com/setup_20.x | sudo -E bash -
sudo apt-get update
sudo apt-get install -y git nodejs libkrb5-dev
npm install -g yarn@1.22.22
yarn install

Testing

Run the following command:

yarn test

or if you are using VSCode, you can use the Jest Extension to run the tests directly from the IDE. This comes preloaded in the Dev container.

Demoing the plugins

Run the following command:

yarn dev

This should startup the local Backstage app with all the plugins loaded.

To view the app, you can navigate to https://localhost:3000.