Skip to content

Commit

Permalink
docs: update docs with instructions for dev. (#7)
Browse files Browse the repository at this point in the history
  • Loading branch information
franTarkenton authored Sep 18, 2024
1 parent b066016 commit 4a544af
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 10 deletions.
20 changes: 11 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
[![MIT License](https://img.shields.io/github/license/bcgov/quickstart-openshift.svg)](/LICENSE.md)
[![Lifecycle](https://img.shields.io/badge/Lifecycle-Experimental-339999)](https://github.com/bcgov/repomountie/blob/master/doc/lifecycle-badges.md)

[![Merge](https://github.com/bcgov/quickstart-openshift/actions/workflows/merge.yml/badge.svg)](https://github.com/bcgov/quickstart-openshift/actions/workflows/merge.yml)
[![Analysis](https://github.com/bcgov/quickstart-openshift/actions/workflows/analysis.yml/badge.svg)](https://github.com/bcgov/quickstart-openshift/actions/workflows/analysis.yml)
[![Scheduled](https://github.com/bcgov/quickstart-openshift/actions/workflows/scheduled.yml/badge.svg)](https://github.com/bcgov/quickstart-openshift/actions/workflows/scheduled.yml)
[![Merge](https://github.com/bcgov/qsos-leaflet/actions/workflows/merge.yml/badge.svg)](https://github.com/bcgov/qsos-leaflet/actions/workflows/merge.yml)
[![Analysis](https://github.com/bcgov/qsos-leaflet/actions/workflows/analysis.yml/badge.svg)](https://github.com/bcgov/qsos-leaflet/actions/workflows/analysis.yml)
[![Scheduled](https://github.com/bcgov/qsos-leaflet/actions/workflows/scheduled.yml/badge.svg)](https://github.com/bcgov/qsos-leaflet/actions/workflows/scheduled.yml)

##### Frontend (JavaScript/TypeScript)
##### Frontend - Leaflet (JavaScript/TypeScript)
<!-- [![Bugs](https://sonarcloud.io/api/project_badges/measure?project=quickstart-openshift_frontend&metric=bugs)](https://sonarcloud.io/summary/new_code?id=quickstart-openshift_frontend)
[![Code Smells](https://sonarcloud.io/api/project_badges/measure?project=quickstart-openshift_frontend&metric=code_smells)](https://sonarcloud.io/summary/new_code?id=quickstart-openshift_frontend)
[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=quickstart-openshift_frontend&metric=coverage)](https://sonarcloud.io/summary/new_code?id=quickstart-openshift_frontend)
Expand All @@ -16,11 +16,17 @@
[![Technical Debt](https://sonarcloud.io/api/project_badges/measure?project=quickstart-openshift_frontend&metric=sqale_index)](https://sonarcloud.io/summary/new_code?id=quickstart-openshift_frontend)
[![Vulnerabilities](https://sonarcloud.io/api/project_badges/measure?project=quickstart-openshift_frontend&metric=vulnerabilities)](https://sonarcloud.io/summary/new_code?id=quickstart-openshift_frontend) -->

<image src="https://lh3.googleusercontent.com/pw/AP1GczNhzPJlfI99flndihLVvYO654vUWnKATfp92GfrLn0bBSyxV57x38S3M91xKMfxm5W-VkKG9zSdfFz7wQgp5QIQCFnFu9lAdeIZiJma_BuOHdz6I3a0wC-qsggt5ghe9Vw-soMWksX7Th3DXsWO1msUAg=w1420-h800-s-no-gm?authuser=0" width="800px">

# Leaflet QuickStart for OpenShift

This is repo / template is experimental at this stage. The bulk of the content has shamelessly been stolen from the openshift [quickstart template repo](https://github.com/bcgov/quickstart-openshift)

# Local Development with Leaflet QuickStart for OpenShift

[see docs here](./docs/local_dev.md)


## Pull Request-Based Workflows with Sample Stack

_the following statement is aspirational_
Expand Down Expand Up @@ -183,10 +189,6 @@ To opt-in:
* Select "Submit new issue"
* Wait for Renovate to start sending pull requests to your repository

### Dependabot

Dependabot is no longer recommended as an alternative to Renovate for generating security, vulnerability and dependency pull requests. It can still be used to generate warnings under the GitHub Security tab, which is only viewable by repository administrators.

## Repository Configuration

### Pull Request Handling
Expand All @@ -209,7 +211,7 @@ Pull Requests:

Packages are available from your repository (link on right). All should have visibility set to public for the workflows to run successfully.

E.g. https://github.com/bcgov/quickstart-openshift/packages
E.g. https://github.com/bcgov/qsos-leaflet/packages

### Branch Protection

Expand Down
15 changes: 14 additions & 1 deletion docs/local_dev.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,19 @@ cd frontend
npm run dev
```

Should set things up allowing for local development
Should set things up allowing for local development. The npm served version
of the app can be viewed at [http://localhost:3000/index.html](http://localhost:3000/index.html)

# Docker

You can also serve the app up through the docker-compose file that exists in the
repository.

`docker compose up frontend`

The Docker compose version can be viewed at:
[http://localhost:3005/index.html](http://localhost:3005/index.html)

# Deployments

If you push your branch and trigger a

0 comments on commit 4a544af

Please sign in to comment.