https://github.com/bcgov/pubcode

This repository will house all the source code and artifacts related to public code asset management of BCGov.
https://github.com/bcgov/pubcode

express mongodb nodejs react

Last synced: 3 months ago
JSON representation

This repository will house all the source code and artifacts related to public code asset management of BCGov.

• Host: GitHub
• URL: https://github.com/bcgov/pubcode
• Owner: bcgov
• License: apache-2.0
• Created: 2022-12-07T17:51:23.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2026-01-02T08:35:35.000Z (5 months ago)
• Last Synced: 2026-01-06T05:15:16.384Z (5 months ago)
• Topics: express, mongodb, nodejs, react
• Language: JavaScript
• Homepage: https://pubcode.apps.silver.devops.gov.bc.ca/
• Size: 2.73 MB
• Stars: 11
• Watchers: 2
• Forks: 0
• Open Issues: 15
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md
  • Codeowners: .github/CODEOWNERS
  • Security: SECURITY.md

Awesome Lists containing this project

README

          


[![Issues](https://img.shields.io/github/issues/bcgov/pubcode)](/../../issues)

[![Pull Requests](https://img.shields.io/github/issues-pr/bcgov/pubcode)](/../../pulls)

[![MIT License](https://img.shields.io/github/license/bcgov/pubcode.svg)](/LICENSE.md)

[![Lifecycle](https://img.shields.io/badge/Lifecycle-Experimental-339999)](https://github.com/bcgov/repomountie/blob/master/doc/lifecycle-badges.md)

# BCGov public code asset tracking

This contains schema definitions for yml and a web application to assist end users to create/edit bcgovpubcode.yml files, store them in a MongoDB database and retrieve them using a Node/Express API.

## Architecture

![Pub Code Architecture](.diagrams/architecture/pub-code.drawio.svg)

## FAQ

Please click [here](https://github.com/bcgov/pubcode/wiki/Frequently-Asked-Questions)

## Components

1. Database (MongoDB): Stores all bcgovpubcode.yml files, converted to JSON, for each participating repo in the bcgov organization.

2. Backend (Node/Express API): Provides read and write access to the database. The read endpoint is open to the public, while the write endpoint is protected by an API key. Both are rate-limited.

3. Crawler (Node module): Crawls through GitHub repos on a schedule, collects any bcgovpubcode.yml files, converts to JSON, and stores using the API's write endpoint.

4. Frontend (React.js and MaterialUI): Allows users to create bcgovpubcode.yml files or edit existing ones using a GitHub link.

5. Schema (JSON Schema): The standard on which the bcgovpubcode.yml file is based.

## How it works

1. The Crawler runs in a [scheduled GitHub Action](.github/workflows/pubcode-crawler-on-scheduler.yml), collecting bcgovpubcode.yml files from participating GitHub repositories.

2. Yaml is converted to JSON and sent to the API's write endpoint, which is secured with an API key.

3. The API stores to the MongoDB database.

4. Users can access all data from the API's read endpoint.

5. Frontend allows users to create or edit bcgovpubcode.yml files, which are validated against the [JSON schema](schema/bcgovpubcode.json).

## Note

Only the Crawler module is allowed to call the APIs post endpoint, which uses the MongoDB as its source of truth.

```mermaid

sequenceDiagram

  participant Crawler

  participant API

  participant MongoDB

  participant Frontend

  participant JSON Schema

  participant GitHub Repos

  Crawler->>GitHub Repos: Crawls through

  GitHub Repos->>Crawler: Collects bcgovpubcode.yml files

  Crawler->>API: Calls the secured post endpoint

  API->>MongoDB: Stores JSON data

  Frontend->>JSON Schema: Uses as standard to create or edit bcgovpubcode.yml files

```

## More Information

Please see README.md files in each component's folder to learn more.

[api/README.md](api/README.md)

[schema/README.md](schema/README.md)

[frontend/README.md](frontend/README.md)

[crawler/README.md](crawler/README.md)