Skip to content

Commit

Permalink
Update docs to remove pluggable backends
Browse files Browse the repository at this point in the history
  • Loading branch information
DerekRoberts committed Oct 16, 2024
1 parent b89853f commit d56e7a5
Showing 1 changed file with 6 additions and 9 deletions.
15 changes: 6 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ Features:
* Database: Postgres, PostGIS, backups, Flyway
* Frontend: TypeScript, Caddy Server
* Backend: TypeScript, Nest.js
* Alternative backends for [Java/Quarkus, Go/Fiber and Python/FastAPI](https://github.com/bcgov/quickstart-openshift-backends)
* Alternative backend examples - see [Alternative Backends](#alternative-backends)

# Setup

Expand Down Expand Up @@ -347,7 +347,7 @@ Please note that the label must be manually created using GitHub's web interface

## Starter

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.
The starter stack includes a frontend (React, MUI, Vite, Caddy), backend (Nest/Node) and postgres or postgis database. See subfolder for source, including Dockerfiles and OpenShift templates. Alternative backends are available.

Features:
* [TypeScript](https://www.typescriptlang.org/) strong-typing for JavaScript
Expand All @@ -360,14 +360,12 @@ Postgres is default. Switch to PostGIS by copying the appropriate Dockerfile to

> cp ./database/postgis/Dockerfile ./database
## Pluggable Backends
## Alternative Backends

This quickstart works with more than just JavaScript. Please check out our pluggable [backends repository](https://github.com/bcgov/quickstart-openshift-backends). Flyway-based database migrations for each are included.
The pluggable backends repository has been archived, but we have lots of other great examples of active projects you can learn from!

Supported languages:
* [Go with Fiber](https://github.com/bcgov/quickstart-openshift-backends/tree/main/backend-go)
* [Java with Quarkus, Cloud Native](https://github.com/bcgov/quickstart-openshift-backends/tree/main/backend-go)
* [Python with FastAPI](https://github.com/bcgov/quickstart-openshift-backends/tree/main/backend-py)
* [NR-RFC-AlertAuthoring - Python with FastAPI and Alembic](https://github.com/bcgov/nr-rfc-alertauthoring)
* [NR-SPAR - Java with Quarkus, Cloud Native and Flyway](https://github.com/bcgov/nr-spar)

## SchemaSpy

Expand All @@ -387,7 +385,6 @@ After a full workflow run and merge can been run, please do the following:
This repository is provided by NRIDS Architecture and Forestry Digital Services, courtesy of the Government of British Columbia.

* NRID's [Kickstarter Guide](https://bcgov.github.io/nr-architecture-patterns-library/docs/Agile%20Team%20Kickstarter) (via. Confluence, links may be internal)
* [OpenShift Backends for Go, Java and Python](https://github.com/bcgov/quickstart-openshift-backends)

# Contributing

Expand Down

0 comments on commit d56e7a5

Please sign in to comment.