bcgov / digital-gov

CSI Labs Applications and Web Presence
https://digital.pathfinder.gov.bc.ca
Other
3 stars 0 forks source link

description: This is the primary repository for the CSI Labs author: gh:patricksimonian

Digital Gov Web App

This is the primary repository for the BC Gov CSI Labs web presence.

Technology Stack Used

Third-Party Products/Libraries used and the the License they are covered by

Project Status

In Development

Security

Authentication, Authorization, Policies, etc

Currently, CSI Labs is a statically generated site (generated using GatsbyJS) and served using Caddy Server and has no concept of users, authentication, or authorization. This will likely change in the future at which point this documentation will be updated to reflect details in those areas.

Code Management

Workflow

This project follows the GitHub Flow workflow for managing code branches and releases. Details and more specifics of how features are developed and rolled out are described below.

Do not attempt to merge a PR on your own, the jenkins process merges pull requests when promoted through the stages dev test prod.

Feature Lifecycle and Release Process

As indicated above, the team follows the GitHub approach for managing code and releases. Accompanying this general approach the team has implemented some specific structures, tools and practices that are described in this section.

Branch Structure

In the repo, at any given time, several to many branches may exist, and these can be categorized into a few "types" of branches, used for specific purposes. Each is outlined below.

Lifecycle

Feature lifecycle is as follows:

Files in this repository

cmd to update tree (from project root) tree -I 'node_modules|coverage|.cache|app-web/public' -d -L 3

├── app-web
│   ├── __fixtures__
│   ├── __mocks__
│   ├── __tests__
│   │   ├── components
│   │   ├── pages
│   ├── config
│   │   └── jest
│   ├── gatsby
│   ├── public
│   │   └── static
│   ├── shell-scripts
│   └── src
│       ├── assets
│       ├── components
│       ├── constants
│       ├── hoc
│       ├── pages
├── docs
├── functional-tests
│   ├── gradle
│   │   └── wrapper
│   └── src
│       └── test
├── openshift
└── pipeline
├── gradle
│   └── wrapper
└── src
└── groovy

Getting Started

Deployment (Local Development For App-Web)

Deployment (Docker for Local Development)

Deployment (OpenShift)

See (openshift/Readme.md)

Getting Help or Reporting an Issue

To report bugs/issues/feature requests, please file an issue.

How to Contribute

If you would like to contribute, please see our CONTRIBUTING guidelines.

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

Issues/Suggestions

Make Suggestions/Issues here! Issues are markdown supported.

License

Copyright 2019 Province of British Columbia

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.