Developer Portal

This is the proof of concept of the Connected Services Integration Toolkit integrated into the developer portal for the Province of British Columbia built using Backstage.

Local Development

Required Tools

• Node long-term-support version (i.e. lts/hydrogen)

Setup

• For development purposes, the in memory SQLite database is sufficient (it is already configured)
  • Alternativley, Postgres can be configured
    • Install Postgres locally or via docker
• Create an app-config.local.yaml file based off of the app-config.local.template.yaml file.

Running

To run the project:

1. Follow the plugin instructions to be able to pull the plugin from GitHub Packages.

2. Ensure you have the GITHUB_TOKEN environment variable set with a GitHub Personal Access Token that has access to the package.

$ export GITHUB_TOKEN=your_personal_access_token

3. Run the following at the project's root directory

$ yarn install
$ yarn start

Testing

End to end tests are in the packages/app/e2e-tests directory.

To run locally:

• start a local instance
• yarn test:e2e

To run against a dev instance:

• Set the PLAYWRIGHT_URL to your dev instance when running the test
• PLAYWRIGHT_URL=https://dev.example.org yarn test:e2e

Dockerfile

Note: The dockerfile is based on the Janus showcase project

Using Docker locally, requires us to set the GITHUB_TOKEN:

$ docker buildx build \
  --secret id=GITHUB_TOKEN,env=GITHUB_TOKEN \
  -f packages/backend/Dockerfile \
  .

Note: You will need to modify app-config.production.yaml to fit your local environment if you plan to run the docker image locally.

Deployment

See the gitops repo.

More information

See the Backstage.io documentation