Code Monkey home page Code Monkey logo

quickstart-openshift-backends's Introduction

MIT License Lifecycle Merge Analysis

QuickStart: Pluggable Backends

OpenShift, Go, Java, Python

These are pluggable backends intended for use with the QuickStart for Openshift, which defaults to JavaScript/TypeScripts. They follow the same patterns and can be copied over.

  • Pluggable backends:
    • Backend: Java, Quarkus, Cloud Native
    • Backend: Go, Fiber
    • Backend: Python, FastAPI

Sample Application

The starter stack includes a (React, MUI, Vite, Caddy) frontend, Pluggable backend(Nest/Node, Quarkus/Java On Native, FastAPI/Python, Fiber/Golang) and postgres database. See subfolder for source, including Dockerfiles and OpenShift templates.

Features:

Acknowledgements

This Action is provided courtesy of the Forestry Suite of Applications, part of the Government of British Columbia.

quickstart-openshift-backends's People

Contributors

bcgov-devops avatar dependabot[bot] avatar derekroberts avatar mishraomp avatar renovate[bot] avatar

Stargazers

avatar avatar

Watchers

avatar avatar avatar

quickstart-openshift-backends's Issues

Lets use common phrasing

TL;DR 🏎️

Teams are encouraged to favour modern inclusive phrasing both in their communication as well as in any source checked into their repositories. You'll find a table at the end of this text with preferred phrasing to socialize with your team.

Words Matter

We're aligning our development community to favour inclusive phrasing for common technical expressions. There is a table below that outlines the phrases that are being retired along with the preferred alternatives.

During your team scrum, technical meetings, documentation, the code you write, etc. use the inclusive phrasing from the table below. That's it - it really is that easy.

For the curious mind, the Public Service Agency (PSA) has published a guide describing how Words Matter in our daily communication. Its an insightful read and a good reminder to be curious and open minded.

What about the master branch?

The word "master" is not inherently bad or non-inclusive. For example people get a masters degree; become a master of their craft; or master a skill. It's generally when the word "master" is used along side the word "slave" that it becomes non-inclusive.

Some teams choose to use the word main for the default branch of a repo as opposed to the more commonly used master branch. While it's not required or recommended, your team is empowered to do what works for them. If you do rename the master branch consider using main so that we have consistency among the repos within our organization.

Preferred Phrasing

Non-Inclusive Inclusive
Whitelist => Allowlist
Blacklist => Denylist
Master / Slave => Leader / Follower; Primary / Standby; etc
Grandfathered => Legacy status
Sanity check => Quick check; Confidence check; etc
Dummy value => Placeholder value; Sample value; etc

Pro Tip 🤓

This list is not comprehensive. If you're aware of other outdated nomenclature please create an issue (PR preferred) with your suggestion.

ZAP: backend-java

View the following link to download the report.
RunnerID:7678170664

ZAP: backend-go

View the following link to download the report.
RunnerID:6424622615

feat: update pydantic to 2.0

Already completed elsewhere by @conbrad.

WPS PR
bcgov/wps#3028

--- copy/paste ---
conbrad commented 27 minutes ago
@franTarkenton or @conbrad do you have some time to help us and move from pydantic from v1 to v2? cc @DerekRoberts

@mishraomp I can try to carve out some time tomorrow. We've updated this here: bcgov/wps#3028
I'll be less familiar with your domain models so that will require some extra testing from your team but as a short summary, what I found was:

Optional fields set to None by default are more strict on type annotations
Datetime format has changed to expect the Zulu "Z" notation
parse_obj -> model_validate if you're using that anywhere

ZAP: backend-go

View the following link to download the report.
RunnerID:7678170664

feat: set up repo focusing on backends

Reuse/import parts of bcgov/quickstart-openshift rather than build them in this repository. Focus instead on the Go, Java and Python backends. Set up "pluggability."

ZAP: backendGo

View the following link to download the report.
RunnerID:8030084417

Add project lifecycle badge

No Project Lifecycle Badge found in your readme!

Hello! I scanned your readme and could not find a project lifecycle badge. A project lifecycle badge will provide contributors to your project as well as other stakeholders (platform services, executive) insight into the lifecycle of your repository.

What is a Project Lifecycle Badge?

It is a simple image that neatly describes your project's stage in its lifecycle. More information can be found in the project lifecycle badges documentation.

What do I need to do?

I suggest you make a PR into your README.md and add a project lifecycle badge near the top where it is easy for your users to pick it up :). Once it is merged feel free to close this issue. I will not open up a new one :)

Add missing topics

TL;DR

Topics greatly improve the discoverability of repos; please add the short code from the table below to the topics of your repo so that ministries can use GitHub's search to find out what repos belong to them and other visitors can find useful content (and reuse it!).

Why Topic

In short order we'll add our 800th repo. This large number clearly demonstrates the success of using GitHub and our Open Source initiative. This huge success means it's critical that we work to make our content as discoverable as possible. Through discoverability, we promote code reuse across a large decentralized organization like the Government of British Columbia as well as allow ministries to find the repos they own.

What to do

Below is a table of abbreviation a.k.a short codes for each ministry; they're the ones used in all @gov.bc.ca email addresses. Please add the short codes of the ministry or organization that "owns" this repo as a topic.

add a topic

That's it, you're done!!!

How to use

Once topics are added, you can use them in GitHub's search. For example, enter something like org:bcgov topic:citz to find all the repos that belong to Citizens' Services. You can refine this search by adding key words specific to a subject you're interested in. To learn more about searching through repos check out GitHub's doc on searching.

Pro Tip 🤓

  • If your org is not in the list below, or the table contains errors, please create an issue here.

  • While you're doing this, add additional topics that would help someone searching for "something". These can be the language used javascript or R; something like opendata or data for data only repos; or any other key words that are useful.

  • Add a meaningful description to your repo. This is hugely valuable to people looking through our repositories.

  • If your application is live, add the production URL.

Ministry Short Codes

Short Code Organization Name
AEST Advanced Education, Skills & Training
AGRI Agriculture
ALC Agriculture Land Commission
AG Attorney General
MCF Children & Family Development
CITZ Citizens' Services
DBC Destination BC
EMBC Emergency Management BC
EAO Environmental Assessment Office
EDUC Education
EMPR Energy, Mines & Petroleum Resources
ENV Environment & Climate Change Strategy
FIN Finance
FLNR Forests, Lands, Natural Resource Operations & Rural Development
HLTH Health
IRR Indigenous Relations & Reconciliation
JEDC Jobs, Economic Development & Competitiveness
LBR Labour Policy & Legislation
LDB BC Liquor Distribution Branch
MMHA Mental Health & Addictions
MAH Municipal Affairs & Housing
BCPC Pension Corporation
PSA Public Service Agency
PSSG Public Safety and Solicitor General
SDPR Social Development & Poverty Reduction
TCA Tourism, Arts & Culture
TRAN Transportation & Infrastructure
WLRS Water, Land and Resource Stewardship

NOTE See an error or omission? Please create an issue here to get it remedied.

ZAP: backend-py

View the following link to download the report.
RunnerID:6424622615

Dependency Dashboard

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Other Branches

These updates are pending. To force PRs open, click the checkbox below.

  • chore(deps): update bcgov-nr/action-builder-ghcr action to v2

Open

These updates have all been created already. Click a checkbox below to force a retry/rebase of any.

Detected dependencies

docker-compose
docker-compose.yml
  • postgres 15
  • flyway/flyway 9-alpine
  • flyway/flyway 9-alpine
  • python 3.11-slim-buster
  • python 3.11
  • python 3.11
dockerfile
backend-go/Dockerfile
  • golang 1.21
  • alpine 3.18
backend-go/db/Dockerfile
  • flyway/flyway 9.22-alpine
backend-java/Dockerfile
  • quay.io/quarkus/quarkus-micro-image 2.0
backend-py/Dockerfile
backend-py/db/Dockerfile
  • flyway/flyway 9.22-alpine
github-actions
.github/workflows/analysis.yml
  • actions/checkout v4
  • github/codeql-action v2
  • github/codeql-action v2
  • actions/setup-java v3
  • actions/cache v3
  • github/codeql-action v2
  • actions/checkout v4
  • aquasecurity/trivy-action 0.12.0
  • github/codeql-action v2
  • actions/checkout v4
  • actions/setup-java v3
  • actions/cache v3
  • actions/checkout v4
  • actions/setup-python v4
  • actions/cache v3
  • snok/install-poetry v1.3.4
  • actions/cache v3
  • ubuntu 22.04
  • ubuntu 22.04
  • ubuntu 22.04
  • ubuntu 22.04
.github/workflows/merge.yml
  • bcgov-nr/action-deployer-openshift v2.0.0
  • actions/checkout v4
  • actions/cache v3
  • actions/delete-package-versions v4
  • bcgov-nr/action-deployer-openshift v2.0.0
  • shrink/actions-docker-registry-tag v3
  • actions/checkout v4
  • joshuaavalon/flyway-action v3.0.0
  • JamesIves/github-pages-deploy-action v4
  • ubuntu 22.04
  • ubuntu 22.04
  • ubuntu 22.04
  • ubuntu 22.04
  • ubuntu 22.04
.github/workflows/pentests.yml
  • zaproxy/action-full-scan v0.7.0
.github/workflows/pr-close.yml
  • shrink/actions-docker-registry-tag v3
  • ubuntu 22.04
  • ubuntu 22.04
.github/workflows/pr-open.yml
  • bcgov-nr/action-pr-description-add v1.1.0
  • bcgov-nr/action-builder-ghcr v1.3.0
  • bcgov-nr/action-deployer-openshift v2.0.0
  • ubuntu 22.04
  • ubuntu 22.04
  • ubuntu 22.04
gomod
backend-go/go.mod
  • go 1.21
  • github.com/devfeel/mapper v0.7.13
  • github.com/gofiber/fiber/v2 v2.49.2
  • github.com/gofiber/helmet/v2 v2.2.26
  • github.com/gofiber/swagger v0.1.12
  • github.com/golang-migrate/migrate/v4 v4.16.2
  • github.com/joho/godotenv v1.5.1
  • github.com/sirupsen/logrus v1.9.3
  • github.com/swaggo/swag v1.16.1
  • gorm.io/driver/postgres v1.5.2
  • gorm.io/gorm v1.25.4
maven
backend-java/pom.xml
  • io.quarkus.platform:quarkus-bom 3.4.1
  • org.instancio:instancio-junit 3.2.0
  • net.datafaker:datafaker 2.0.1
  • io.quarkus.platform:quarkus-maven-plugin 3.4.1
  • org.apache.maven.plugins:maven-compiler-plugin 3.11.0
  • org.apache.maven.plugins:maven-surefire-plugin 3.1.2
  • org.apache.maven.plugins:maven-failsafe-plugin 3.1.2
maven-wrapper
backend-java/.mvn/wrapper/maven-wrapper.properties
  • maven 3.9.4
  • maven-wrapper 3.2.0
npm
integration-tests/package.json
  • axios ^1.4.0
  • dotenv ^16.1.4
  • js-yaml ^4.1.0
  • lodash ^4.17.21
poetry
backend-py/pyproject.toml
  • python ^3.11
  • fastapi ^0.103.0
  • uvicorn ^0.23.0
  • sqlalchemy ^2.0.21
  • pydantic ^1.10.9
  • requests ^2.31.0
  • psycopg2 ^2.9.1
  • prospector ^1.10.2
  • pytest ^7.3.2
  • pytest-cov ^4.1.0
  • pytest-watch ^4.2.0

bug: python builds failing 

Dockerfile:11
--------------------
  10 |     COPY pyproject.toml poetry.lock ./
  11 | >>> RUN pip install poetry==1.2.2 && \
  12 | >>>     poetry install --no-root -vvv --without dev --sync
  13 |     
--------------------
ERROR: failed to solve: process "/bin/sh -c pip install poetry==1.2.2 &&     poetry install --no-root -vvv --without dev --sync" did not complete successfully: exit code: 1

ZAP: backendJava

View the following link to download the report.
RunnerID:8030084417

ZAP: backendPy

View the following link to download the report.
RunnerID:8030084417

ZAP: backend-java

View the following link to download the report.
RunnerID:6424622615

Dependency Dashboard

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Awaiting Schedule

These updates are awaiting their schedule. Click on a checkbox to get an update now.

  • chore(deps): lock file maintenance

Rate-Limited

These updates are currently rate-limited. Click on a checkbox below to force their creation now.

  • fix(deps): update all non-major dependencies (fastapi, gorm.io/gorm, postgresql)

Edited/Blocked

These updates have been manually edited so Renovate will no longer make changes. To discard all commits and start over, click on a checkbox.

  • fix(deps): update dependency pydantic to v2

Pending Status Checks

These updates await pending status checks. To force their creation now, click the checkbox below.

  • chore(deps): update bcgov/quickstart-openshift-helpers action to v0.4.1
  • fix(deps): update maven all non-major dependencies (net.datafaker:datafaker, org.instancio:instancio-junit, io.quarkus.platform:quarkus-maven-plugin, io.quarkus.platform:quarkus-bom, org.apache.maven.plugins:maven-compiler-plugin)
  • chore(deps): update dependency pytest-cov to v5

Detected dependencies

docker-compose
docker-compose.yml
  • postgres 15
  • flyway/flyway 9-alpine
  • flyway/flyway 9-alpine
  • python 3.11-slim-buster
  • python 3.12
  • python 3.12
dockerfile
backend-go/Dockerfile
  • golang 1.22
  • alpine 3.19
backend-go/db/Dockerfile
  • flyway/flyway 9.22-alpine
backend-java/Dockerfile
  • quay.io/quarkus/quarkus-micro-image 2.0
backend-py/Dockerfile
backend-py/db/Dockerfile
  • flyway/flyway 9.22-alpine
github-actions
.github/workflows/.deploy.yml
  • actions/checkout v4
  • ubuntu 22.04
.github/workflows/analysis.yml
  • actions/checkout v4
  • github/codeql-action v3
  • github/codeql-action v3
  • actions/setup-java v4
  • actions/cache v4
  • github/codeql-action v3
  • actions/checkout v4
  • aquasecurity/trivy-action 0.19.0
  • github/codeql-action v3
  • actions/checkout v4
  • actions/setup-java v4
  • actions/cache v4
  • actions/checkout v4
  • actions/setup-python v5
  • actions/cache v4
  • snok/install-poetry v1.3.4
  • actions/cache v4
  • ubuntu 22.04
  • ubuntu 22.04
  • ubuntu 22.04
  • ubuntu 22.04
.github/workflows/merge.yml
  • bcgov-nr/action-get-pr v0.0.1
  • actions/checkout v4
  • actions/cache v4
  • shrink/actions-docker-registry-tag v4
  • actions/delete-package-versions v5
  • ubuntu 22.04
  • ubuntu 22.04
  • ubuntu 22.04
.github/workflows/pentests.yml
  • zaproxy/action-full-scan v0.10.0
.github/workflows/pr-close.yml
  • bcgov/quickstart-openshift-helpers v0.4.0
.github/workflows/pr-edit.yml
  • bcgov/quickstart-openshift-helpers v0.4.0
.github/workflows/pr-open.yml
  • bcgov-nr/action-builder-ghcr v2.0.2
  • bcgov/quickstart-openshift-helpers v0.4.0
  • ubuntu 22.04
gomod
backend-go/go.mod
  • go 1.21
  • go 1.22.2
  • github.com/devfeel/mapper v0.7.13
  • github.com/gofiber/fiber/v2 v2.52.4
  • github.com/gofiber/helmet/v2 v2.2.26
  • github.com/gofiber/swagger v1.0.0
  • github.com/golang-migrate/migrate/v4 v4.17.1
  • github.com/joho/godotenv v1.5.1
  • github.com/sirupsen/logrus v1.9.3
  • github.com/swaggo/swag v1.16.3
  • gorm.io/driver/postgres v1.5.7
  • gorm.io/gorm v1.25.9
helm-values
charts/quickstart-openshift-backends/values.yaml
  • ghcr.io/bcgov/nr-containers/bitnami/postgresql 15.6.0
helmv3
charts/quickstart-openshift-backends/Chart.yaml
  • postgresql 15.2.5
maven
backend-java/pom.xml
  • io.quarkus.platform:quarkus-bom 3.8.2
  • org.instancio:instancio-junit 4.3.2
  • net.datafaker:datafaker 2.1.0
  • io.quarkus.platform:quarkus-maven-plugin 3.8.2
  • org.apache.maven.plugins:maven-compiler-plugin 3.12.1
  • org.apache.maven.plugins:maven-surefire-plugin 3.2.5
  • org.apache.maven.plugins:maven-failsafe-plugin 3.2.5
maven-wrapper
backend-java/.mvn/wrapper/maven-wrapper.properties
  • maven 3.9.6
npm
integration-tests/package.json
  • axios ^1.6.8
  • dotenv ^16.4.5
  • js-yaml ^4.1.0
  • lodash ^4.17.21
pep621
backend-py/pyproject.toml
poetry
backend-py/pyproject.toml
  • python ^3.11
  • fastapi ^0.110.0
  • uvicorn ^0.29.0
  • sqlalchemy ^2.0.21
  • pydantic ^1.10.9
  • requests ^2.31.0
  • psycopg2 ^2.9.1
  • prospector ^1.10.2
  • pytest ^8.0.0
  • pytest-cov ^4.1.0
  • pytest-watch ^4.2.0
  • Check this box to trigger a request for Renovate to run again on this repository

ZAP: backend-py

View the following link to download the report.
RunnerID:7431159837

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.