Skip to content

Latest commit

 

History

History
44 lines (30 loc) · 1.04 KB

README.md

File metadata and controls

44 lines (30 loc) · 1.04 KB
Raw

Pub Code UI

This UI is a React app built with Vite and served by Caddy.

Goal

It helps users to:

  1. Produce a bcgovpubcode.yml file from scratch
  2. Edit exiting bcgovpubcode.yml files by web link

Process

The user fills out a form, which generates a bcgovpubcode.yml file, which can be downloaded or copied/pasted to add their GitHub repository. It is validated using the React json schema form library.

OpenShift Deployment

Each Pull Request workflow creates a sandboxed environment deployed in OpenShift. A temporary URL is provided as part of the PR's checks. Environments are removed when their PRs are closed.

Local Development

Prerequisites:

  • Node.js 18

Steps:

  1. Clone the repository 
    git clone https://github.com/bcgov/pubcode.git
    OR 
    git clone [email protected]:bcgov/pubcode.git
  2. Install dependencies 
    npm ci
  3. Run the app 
    npm run dev