Skip to content

Commit 4a544af

Browse files
docs: update docs with instructions for dev. (#7)
1 parent b066016 commit 4a544af

File tree

2 files changed

+25
-10
lines changed

2 files changed

+25
-10
lines changed

README.md

+11-9
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
[![MIT License](https://img.shields.io/github/license/bcgov/quickstart-openshift.svg)](/LICENSE.md)
22
[![Lifecycle](https://img.shields.io/badge/Lifecycle-Experimental-339999)](https://github.com/bcgov/repomountie/blob/master/doc/lifecycle-badges.md)
33

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

8-
##### Frontend (JavaScript/TypeScript)
8+
##### Frontend - Leaflet (JavaScript/TypeScript)
99
<!-- [![Bugs](https://sonarcloud.io/api/project_badges/measure?project=quickstart-openshift_frontend&metric=bugs)](https://sonarcloud.io/summary/new_code?id=quickstart-openshift_frontend)
1010
[![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)
1111
[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=quickstart-openshift_frontend&metric=coverage)](https://sonarcloud.io/summary/new_code?id=quickstart-openshift_frontend)
@@ -16,11 +16,17 @@
1616
[![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)
1717
[![Vulnerabilities](https://sonarcloud.io/api/project_badges/measure?project=quickstart-openshift_frontend&metric=vulnerabilities)](https://sonarcloud.io/summary/new_code?id=quickstart-openshift_frontend) -->
1818

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

2021
# Leaflet QuickStart for OpenShift
2122

2223
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)
2324

25+
# Local Development with Leaflet QuickStart for OpenShift
26+
27+
[see docs here](./docs/local_dev.md)
28+
29+
2430
## Pull Request-Based Workflows with Sample Stack
2531

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

186-
### Dependabot
187-
188-
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.
189-
190192
## Repository Configuration
191193

192194
### Pull Request Handling
@@ -209,7 +211,7 @@ Pull Requests:
209211

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

212-
E.g. https://github.com/bcgov/quickstart-openshift/packages
214+
E.g. https://github.com/bcgov/qsos-leaflet/packages
213215

214216
### Branch Protection
215217

docs/local_dev.md

+14-1
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,19 @@ cd frontend
2323
npm run dev
2424
```
2525

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

29+
# Docker
2830

31+
You can also serve the app up through the docker-compose file that exists in the
32+
repository.
33+
34+
`docker compose up frontend`
35+
36+
The Docker compose version can be viewed at:
37+
[http://localhost:3005/index.html](http://localhost:3005/index.html)
38+
39+
# Deployments
40+
41+
If you push your branch and trigger a

0 commit comments

Comments
 (0)