bcgov / met-public Goto Github PK

Modern Engagement Tool ops

License: Apache License 2.0

HTML 0.20% Shell 0.07% CSS 0.01% TypeScript 48.29% Python 45.22% Dockerfile 0.17% JavaScript 0.13% Mako 0.02% Makefile 0.59% SCSS 5.30%

bcgov eao python-flask reactjs modern-engagement openshift

met-public's Introduction

met-public

The Modern Engagement Tools (MET)

This project is to develop modern engagement tools that address shortfalls identified in the Province’s existing public engagement processes.

Objectives

The goal of this project is to transform B.C.’s public engagement processes and enable the public to provide more value and influence decision-making while generating useful data insights, an enhanced post commenting experience for the user, and minimize rejected comments. The product will be cost effective, leverage investments and successes to date, explore best in class strategies, and be maintainable and continuously improved by government staff. It will be privacy enhancing, and support DRIPA/ GBA+ implementation and analysis, and continuously delivered and tested with users.

Directory Structure

.github/                   - PR, CI action workflows and Issue templates
/docs                      - Miscellaneous documentations
met-web/                   - MET Web application root
├── src/                   - React.js application
└── tests/                 - Application tests
    └── unit/              - Jest unit tests
met-api/                   - MET API Application Root
├── src/                   - Python flask application
│   └── met_api/           - Models, Resources and Services
├── migrations             - Database migration scripts
└── tests/                 - API application tests
    └── unit/              - Python unit tests
notify-api/                - Notification API Application Root
├── src/                   - Python flask application
│   └── notify_api/           - Models, Resources and Services
└── tests/                 - API application tests
met-cron/                  - Job Scheduler Application Root
├── src/                   - Python application
│   └── met_cron/           - Models, Resources and Services
└── tests/                 - Job Scheduler tests
openshift/                 - OpenShift templates and documentation
snowplow/                  - Snowplow custom schemas
CODE-OF-CONDUCT.md         - Code of Conduct
COMPLIANCE.yaml            - BCGov PIA/STRA compliance status
CONTRIBUTING.md            - Contributing Guidelines
LICENSE                    - License

Documentation

Auxiliary Repositories

Getting Help or Reporting an Issue

To report bugs/issues/features 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.

License

Copyright 2022 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.

met-public's People

Contributors

Stargazers

Watchers

Forkers

saravanpa-aot tiagografiti jadmsaadaot djnunez-aot pinkdiamond1 dinesh-aot salabh-aot vineetbala-aot aforde-aot bcgov saxenashiv ratheesh-aot

met-public's Issues

Setup docker

Add docker files to project folders
Add docker compose for postgres, mongo and formio components.

Design Prototype Technical Architecture

Zenhub setup

Add database connection to API

Integrate formio

Add a sample form to our newly created reactjs application, the sample form can be created using the provisioned formio form builder using this link:

https://formio-e903c2-dev.apps.gold.devops.gov.bc.ca/#/

Display sample form in our web application
?...

An Admin user can add a image to the Banner (Header) for the engagement page

As an Admin, I want to add a banner (header) image to the engagement
so that the public can visualize the engagement.

Acceptance Criteria

Scenario 1:

Admin is on the create engagement page and clicks the top section of the Create Engagement page to upload an image. Pop-up opens to let Admin select an image from a few Images available. Admin selects a pre-defined image and clicks the save button. Image is added to the "Create Engagement" page.

Scenario 2:

Admin is on the create engagement page and drags and drops a pre-defined banner image in the top section of the Create Engagement page to upload an image.
Image is added to the "Create Engagement" page.

Scenario 3:

Confirm user interface to the visual design
https://xd.adobe.com/view/e38dc788-12d5-4844-87ca-149d1d32d395-b6de/screen/32caf4d5-99c5-4df2-9e43-620e6b838203
https://xd.adobe.com/view/e38dc788-12d5-4844-87ca-149d1d32d395-b6de/screen/c4541a52-0b8e-40e8-bf9d-78ea1da0404d

Validation Rules?

Screenshot

(Link above will always be the most up-to-date version.)
![Screen Shot 2022-06-10 at 12.20.08 PM.png](https://imag![Screen Shot 2022-06-10 at 12.19.49 PM.png](https://images.zenhubusercontent.com/6261bc1a04c6a94c2edadddd/93e60385-3ced-45bb-88a6-18f7bc44ae7d)es.zenhubusercontent.com/6261bc1a04c6a94c2edadddd/69503424-dae5-417c-b415-4cfdc084ad94)

Banner Images

Admin Site - Landing Page - Engagement Table

An Admin User can designate "Who is Listening" to the engagement page by adding a widget.

An Admin user can designate "Who is Listening" to the engagement page by adding a widget so that the public knows a human is actually listening. It could be a name and photo. For default it could be the ADM, Communications or the Engagement Officer.

Acceptance Criteria:

User clicks the "Add Widget" button in the widget section.
Selects "Who is Listening" from the widget selection.
The public can see an assigned Government Employee's name, picture and/or contact info on the engagement page.
It may have an email link to a personal or group account

Add missing topics

TL;DR

Topics greatly improve the discoverability of repos; please add the short code from the table below to the topics of your repo so that ministries can use GitHub's search to find out what repos belong to them and other visitors can find useful content (and reuse it!).

Why Topic

In short order we'll add our 800th repo. This large number clearly demonstrates the success of using GitHub and our Open Source initiative. This huge success means it's critical that we work to make our content as discoverable as possible. Through discoverability, we promote code reuse across a large decentralized organization like the Government of British Columbia as well as allow ministries to find the repos they own.

What to do

Below is a table of abbreviation a.k.a short codes for each ministry; they're the ones used in all @gov.bc.ca email addresses. Please add the short codes of the ministry or organization that "owns" this repo as a topic.

That's it, you're done!!!

How to use

Once topics are added, you can use them in GitHub's search. For example, enter something like org:bcgov topic:citz to find all the repos that belong to Citizens' Services. You can refine this search by adding key words specific to a subject you're interested in. To learn more about searching through repos check out GitHub's doc on searching.

Pro Tip 🤓

If your org is not in the list below, or the table contains errors, please create an issue here.
While you're doing this, add additional topics that would help someone searching for "something". These can be the language used javascript or R; something like opendata or data for data only repos; or any other key words that are useful.
Add a meaningful description to your repo. This is hugely valuable to people looking through our repositories.
If your application is live, add the production URL.

Ministry Short Codes

Short Code	Organization Name
AEST	Advanced Education, Skills & Training
AGRI	Agriculture
ALC	Agriculture Land Commission
AG	Attorney General
MCF	Children & Family Development
CITZ	Citizens' Services
DBC	Destination BC
EMBC	Emergency Management BC
EAO	Environmental Assessment Office
EDUC	Education
EMPR	Energy, Mines & Petroleum Resources
ENV	Environment & Climate Change Strategy
FIN	Finance
FLNR	Forests, Lands, Natural Resource Operations & Rural Development
HLTH	Health
IRR	Indigenous Relations & Reconciliation
JEDC	Jobs, Economic Development & Competitiveness
LBR	Labour Policy & Legislation
LDB	BC Liquor Distribution Branch
MMHA	Mental Health & Addictions
MAH	Municipal Affairs & Housing
BCPC	Pension Corporation
PSA	Public Service Agency
PSSG	Public Safety and Solicitor General
SDPR	Social Development & Poverty Reduction
TCA	Tourism, Arts & Culture
TRAN	Transportation & Infrastructure

NOTE See an error or omission? Please create an issue here to get it remedied.

An Admin can Log In with IDIR

Description:

As a Admin user I would like to use my goverment account (IDIR) to login into the MET application so that I can manage engagements within the app.

Acceptance Criteria

Users can login using IDIR

Associated tasks -

Create Engagement Landing Page

As a Admin User after I login I would like to see a page where I can manage engagements so that I can see all previously created engagements and be able to create new ones.

Design Page https://xd.adobe.com/view/7360b654-4a25-4140-9670-a56f4adabe7a-2633/screen/c50b5e94-c060-44d5-a636-4be6c3004e64/

Associated Tasks:

Initial Application Setup

An Admin User can create a survey directly on the engagement page to add to my engagement

As an Admin

I want to create a survey

so that I can to add it to my engagement