Skip to content

Service catalogue and developer documentation for the Province of British Columbia

License

Notifications You must be signed in to change notification settings

bcgov/developer-portal

Repository files navigation

Developer Portal

License Package Status CodeQL

This is the developer portal for the Province of British Columbia built using Backstage.

Local Development

Required Tools

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 in the project's root directory and provide the following configurations:
      database:
          client: pg
          connection:
              host: ${POSTGRES_HOST}
              port: ${POSTGRES_PORT}
              user: ${POSTGRES_USER}
              password: ${POSTGRES_PASSWORD}

Running

To run the project, use the following at the project's root directory

$ yarn install
$ yarn dev

Dockerfile

Note: The dockerfile is based on the Janus showcase project

Deployment

See the gitops repo.

More information

See the Backstage.io documentation