bcgov / nr-bcws-wfnews

Primary code repository for WFNEWS 2.0
Apache License 2.0
5 stars 15 forks source link
aws bcws for natural-resource-ministries te terraform terraform-managed wf1 wfnews wildfire

BCWS Situation Report (WFNEWS)

Lifecycle License

Sonar Status

Bugs Maintainability Rating Reliability Rating Security Rating Vulnerabilities

Welcome to WFNEWS 2.0

This is the primary code repository for WFNEWS 2.0

The high-level goals of the Wildfire News project are:

Technologies used

Getting Started

Local Deployment

For local development, we recommend starting individual services with Docker

You can create a database instance via

docker run --name wfnews-postgres -e POSTGRES_USER=wfnews -e POSTGRES_PASSWORD=password -p 5432:5432 -d postgis/postgis:13-3.3
docker pull postgis/postgis:13-3.3

And build the database model with Liquibase:

docker build -t liquibase -f Dockerfile.liquibase.local .
docker run --rm liquibase --url=jdbc:postgresql://<your instance ip>:5432/wfnews --changelog-file=main-changelog.json --username=wfnews --password=password update

Similar docker scripts are provided for running the WFNEWS API and UI respectively. Local development configurations are provided for running the Angular application outside of the Java Spring container.

Storybook

For UI/UX development we have Storybook for developers. You can run storybook using the following command:

ng run WFNEWS:storybook

Create stories for any new or rewritten compoenents.

Node 18+ is required.

CI/CD for DEV/TEST/PROD Deployments

The WFNEWS project is built and deployed via Github actions. A Terraform cloud team server handles running the Terraform. A CI pipeline is setup to run static analysis of the Typescript.

Testing

This project is tested with BrowserStack